Last modified: October 21st, 2021

Getting started

Cloudflare's API exposes the entire Cloudflare infrastructure via a standardized programmatic interface. Using Cloudflare's API, you can do just about anything you can do on cloudflare.com via the customer dashboard.

The Cloudflare API is a RESTful API based on HTTPS requests and JSON responses. If you are registered with Cloudflare, you can obtain your API key from the bottom of the "API Tokens" page, found here: Go to My account.

What is Cloudflare?

Cloudflare makes sites lightning fast, protects them from attacks, ensures they are always online, and makes it simple to add web apps with a single click. Every month, more than 1.8 billion people experience a faster, safer, better Internet thanks to Cloudflare.

Audience for APIs

Cloudflare offers public APIs with three audiences in mind.

  1. Cloudflare customers
  2. Cloudflare partners
  3. Developers

Customers: Individuals and organizations all over the world choose Cloudflare to protect and accelerate their web applications. Most customers manage their settings in the web dashboard, built using these APIs. Virtually anything you can do in the customer dashboard may be done via API. Example: purging the Cloudflare edge cache for a single file when it's updated on the origin server.

Partners: Many organizations make using Cloudflare a seamless option for improving their customers' performance and security. These APIs make that easier to do at scale. Example: a Cloudflare Certified Hosting Partner may use APIs to toggle basic security mode inside a hosting control panel.

Developers: Developers all over the world create useful applications which tie into Cloudflare services. These applications may include plugins and extensions to popular content management systems, apps that are offered in the Cloudflare Apps marketplace, runbooks for specific deployment systems, and many others.

Do's and Don'ts

What can you build with Cloudflare APIs?

Anything that's useful and follows the guidelines presented here.

What should you avoid doing with Cloudflare APIs?

Do not do any of the following:

  • Abuse Cloudflare systems or customers
  • Misuse Cloudflare trademarks
  • Misrepresent Cloudflare services as your own

Abuse: Follow all guidelines, including the rate limits defined below. Your ability to use the Cloudflare APIs may be terminated, temporarily or permanently, if our systems are abused. Similarly, anything in an application which goes against the goal of making Cloudflare more useful to Cloudflare customers or attempts to mistreat customers or their data will be grounds for termination.

Trademarks: Cloudflare has several registered trademarks. Details on how and when you may use Cloudflare trademarks are found at https://www.cloudflare.com/trademark, with links to specifics on logo use and spelling. Please review carefully.

Misrepresentation: Draw a clear line between the benefits you provide in your application and those benefits of the Cloudflare service that you enable via API. The APIs are not intended for "white labeling" or reselling Cloudflare services as your own. Nothing in your service or application should create a false sense of endorsement, sponsorship, or association with Cloudflare. You may sell your own application or service which utilizes the Cloudflare APIs, but may not sell Cloudflare services to customers without a commercial agreement with Cloudflare.

The full Cloudflare Terms of Use are found at https://www.cloudflare.com/terms.

getting-started-endpoints

Endpoints

The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, PATCH, and DELETE methods dictate how your interact with the information available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.

Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. The latest version is Version 4.

The stable base URL for all Version 4 HTTPS endpoints is:

https://api.cloudflare.com/client/v4/

getting-started-requests

Requests

Requests must be sent over HTTPS with any payload formatted in JSON. Depending on if a request is authenticated with the new API Tokens or the old API Keys, required headers differ and are detailed below.

API Tokens

API Tokens provide a new way to authenticate with the Cloudflare API. They allow for scoped and permissioned access to resources and use the RFC compliant Authorization Bearer Token Header.

Required parameters

NameFormatDescription
API TokenAuthorization: Bearer <token>API Token generated from the User Profile 'API Tokens' page

Example request

Requests are generally formatted as follows:

GET object/:object_id
API Token cURL (example)
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
     -H "Content-Type:application/json" \
     -H "Authorization: Bearer YQSn-xWAQiiEh9qM58wZNnyQS7FUdoqGIUAbrh7T"

API Keys

All requests must include both X-Auth-Key and X-Auth-Email headers to authenticate. Requests that use X-Auth-User-Service-Key can use that instead of the Auth-Key and Auth-Email headers.

Required parameters

NameFormatDescription
API KeyX-Auth-KeyAPI key generated on the "My Account" page
EmailX-Auth-EmailEmail address associated with your account
User Service KeyX-Auth-User-Service-KeyA special Cloudflare API key good for a restricted set of endpoints. Always begins with "v1.0-", may vary in length.

Example request

Requests are generally formatted as follows:

GET object/:object_id
Auth-Email cURL (example)
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
     -H "Content-Type:application/json" \
     -H "X-Auth-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
     -H "X-Auth-Email:example@example.com"
User-Service cURL (example)
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d0123e3012345da9420df9514dad0" \
     -H "Content-Type:application/json" \
     -H "X-Auth-User-Service-Key:v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"`

Rate limiting

The Cloudflare API sets a maximum of 1,200 requests in a five minute period.

Pagination

Depending on your request, the results returned may be limited. You can page through the returned results with the following query parameters.

NameTypeDescription
pageintegerWhich page of results to return
per_pageintegerHow many results to return per page
orderstringAttribute name to order the responses by
directionstringEither asc or desc
cURL (example)
GET zones/:zone_identifier/dns_records
curl -X GET "https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/dns_records?page=3&per_page=20&order=type&direction=asc" \
     -H "Content-Type:application/json" \
     -H "X-Auth-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
     -H "X-Auth-Email:example@example.com"
getting-started-responses

Responses

Format

Each response is a JSON object. The data requested is wrapped in the result tag. If you have a response, it will always be within the result field. We also include a success flag, an array of potential errors, and messages in the response. Some responses can have additional pagination info wrapped in the result_info

An error object will contain an integer code field and a message

Date fields will always be in UTC ISO-8601 format, including microseconds.

Success Response (example)
{
  "result": {
    "id":"2d4d028de3015345da9420df5514dad0",
    "type":"A",
    "name":"blog.example.com",
    "content":"2.6.4.5",
    "proxiable":true,
    "proxied":false,
    "ttl":1,
    "priority":0,
    "locked":false,
    "zone_id":"cd7d068de3012345da9420df9514dad0",
    "zone_name":"example.com",
    "modified_on":"2014-05-28T18:46:18.764425Z",
    "created_on":"2014-05-28T18:46:18.764425Z"
  },
  "success": true,
  "errors": [],
  "messages": [],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 200
  }
}
Error Response (example)
{
  "result": null,
  "success": false,
  "errors": [{"code":1003,"message":"Invalid or missing zone id."}],
  "messages": []
}

HTTP Content-Type

The response format can be determined from the HTTP Content-Type header. Most API responses are JSON (Content-Type: application/json).

Content-TypeDescription
application/jsonresponse is a JSON object
text/plainresponse is a textual item
application/x-yamlresponse is a YAML object
application/octet-streamresponse is a raw data (reserved for later use)

HTTP response codes

The status of a response can be determined from the HTTP status code.

CodeStatusDescription
200OKrequest successful
304Not Modified
400Bad Requestrequest was invalid
401Unauthorizeduser does not have permission
403Forbiddenrequest not authenticated
429Too many requestsclient is rate limited
405Method Not Allowedincorrect HTTP method provided
415Unsupported Media Typeresponse is not valid JSON
getting-started-resource-ids

How to get a Zone ID, User ID, or Organization ID

Nearly every resource in the v4 API (Users, Zones, Settings, Organizations, etc.) may be uniquely identified by a 32-byte string of hex characters ([a-f0-9]). These identifiers may be referred to in the documentation as zone_identifier, user_id, or even just id. Identifier values are usually captured during resource creation (POST requests) or when fetching entire collections (GET requests) of resources. Typically they appear as an id field in the JSON resource.

{
  "result": {
    "id":"2d4d028de3015345da9420df5514dad0",
    "type":"example"
  }
}

You can always find the IDs for API resources by making a GET request to its corresponding collection endpoint. For example, to list all Zone objects, a GET request may be sent to https://api.cloudflare.com/client/v4/zones. All objects listed in the result array will contain an id field; this is also known as zone_identifier.

How to Get a Zone ID

curl -X GET "https://api.cloudflare.com/client/v4/zones" \
    -H "X-Auth-Email: user@example.com" \
    -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
    -H "Content-Type: application/json"

User

The currently logged in/authenticated User

user

Object definition

View properties and constraints defined on the object

Show definition

user-user-details

GET User Details permission needed: com.cloudflare.api.user.read
  • free
  • pro
  • business
  • enterprise

GET user
cURL (example)
curl -X GET "https://api.cloudflare.com/client/v4/user" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
Response (example)
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7c5dae5552338874e5053f2534d2767a",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Appleseed",
    "username": "cfuser12345",
    "telephone": "+1 123-123-1234",
    "country": "US",
    "zipcode": "12345",
    "created_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z",
    "two_factor_authentication_enabled": false,
    "suspended": false
  }
}
user-edit-user

PATCH Edit User permission needed: com.cloudflare.api.user.update
  • free
  • pro
  • business
  • enterprise

Edit part of your user details

PATCH user

Optional parameters

Name /typeDescription /exampleConstraints
first_name
stringnull

User's first name

"John"
  • max length: 60
last_name
stringnull

User's last name

"Appleseed"
  • max length: 60
telephone
stringnull

User's telephone number

"+1 123-123-1234"
  • max length: 20
country
stringnull

The country in which the user lives.

"US"
  • max length: 30
zipcode
stringnull

The zipcode or postal code where the user lives.

"12345"
  • max length: 20
cURL (example)
curl -X PATCH "https://api.cloudflare.com/client/v4/user" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"first_name":"John","last_name":"Appleseed","telephone":"+1 123-123-1234","country":"US","zipcode":"12345"}'
Response (example)
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7c5dae5552338874e5053f2534d2767a",
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Appleseed",
    "username": "cfuser12345",
    "telephone": "+1 123-123-1234",
    "country": "US",
    "zipcode": "12345",
    "created_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z",
    "two_factor_authentication_enabled": false,
    "suspended": false
  }
}

User API Tokens

Tokens that can be used to access Cloudflare v4 APIs

user-api-tokens

Object definition

View properties and constraints defined on the object

Show definition

user-api-tokens-list-tokens

GET List Tokens permission needed: com.cloudflare.api.token.list
  • free
  • pro
  • business
  • enterprise

List all access tokens you created

GET user/tokens

Optional parameters

Name /typeDescription /exampleConstraints
page
number

Page number of paginated results

1
  • default value: 1
  • min value:1
per_page
number

Maximum number of results per page

20
  • default value: 20
  • min value:5
  • max value:50
direction
string

Direction to order results

"desc"
  • valid values: asc, desc
cURL (example)
curl -X GET "https://api.cloudflare.com/client/v4/user/tokens?page=1&per_page=20&direction=desc" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
Response (example)
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "ed17574386854bf78a67040be0a770b0",
      "name": "readonly token",
      "status": "active",
      "issued_on": "2018-07-01T05:20:00Z",
      "modified_on": "2018-07-02T05:20:00Z",
      "not_before": "2018-07-01T05:20:00Z",
      "expires_on": "2020-01-01T00:00:00Z",
      "policies": [
        {
          "id": "f267e341f3dd4697bd3b9f71dd96247f",
          "effect": "allow",
          "resources": {
            "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
            "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
          },
          "permission_groups": [
            {
              "id": "c8fed203ed3043cba015a93ad1616f1f",
              "name": "Zone Read"
            },
            {
              "id": "82e64a83756745bbbb1c9c2701bf816b",
              "name": "DNS Read"
            }
          ]
        }
      ],
      "condition": {
        "request.ip": {
          "in": [
            "199.27.128.0/21",
            "2400:cb00::/32"
          ],
          "not_in": [
            "199.27.128.0/21",
            "2400:cb00::/32"
          ]
        }
      }
    }
  ]
}
user-api-tokens-create-token

POST Create Token permission needed: com.cloudflare.api.token.create
  • free
  • pro
  • business
  • enterprise

Create a new access token

POST user/tokens

Required parameters

Name /typeDescription /exampleConstraints
name
string

Token name

"readonly token"
  • max length: 120
policies
array

List of access policies assigned to the token

[ { "id": "f267e341f3dd4697bd3b9f71dd96247f", "effect": "allow", "resources": { "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*", "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*" }, "permission_groups": [ { "id": "c8fed203ed3043cba015a93ad1616f1f", "name": "Zone Read" }, { "id": "82e64a83756745bbbb1c9c2701bf816b", "name": "DNS Read" } ] } ]
An array with items in the following form:

    Optional parameters

    Name /typeDescription /exampleConstraints
    not_before
    string (date-time)

    The time before which the token MUST NOT be accepted for processing

    "2018-07-01T05:20:00Z"
      expires_on
      string (date-time)

      The expiration time on or after which the JWT MUST NOT be accepted for processing

      "2020-01-01T00:00:00Z"
        condition
        object

        Defines the extra limitation on how and/or where the token can be used

        { "request.ip": { "in": [ "199.27.128.0/21", "2400:cb00::/32" ], "not_in": [ "199.27.128.0/21", "2400:cb00::/32" ] } }
        An object with the following properties:
          cURL (example)
          curl -X POST "https://api.cloudflare.com/client/v4/user/tokens" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
     -H "Content-Type: application/json" \
     --data '{"name":"readonly token","not_before":"2018-07-01T05:20:00Z","expires_on":"2020-01-01T00:00:00Z","policies":[{"id":"f267e341f3dd4697bd3b9f71dd96247f","effect":"allow","resources":{"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*","com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"},"permission_groups":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}]}],"condition":{"request.ip":{"in":["199.27.128.0/21","2400:cb00::/32"],"not_in":["199.27.128.0/21","2400:cb00::/32"]}}}'
          Response (example)
          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed17574386854bf78a67040be0a770b0",
    "name": "readonly token",
    "status": "active",
    "issued_on": "2018-07-01T05:20:00Z",
    "modified_on": "2018-07-02T05:20:00Z",
    "not_before": "2018-07-01T05:20:00Z",
    "expires_on": "2020-01-01T00:00:00Z",
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "effect": "allow",
        "resources": {
          "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
          "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
        },
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "name": "DNS Read"
          }
        ]
      }
    ],
    "condition": {
      "request.ip": {
        "in": [
          "199.27.128.0/21",
          "2400:cb00::/32"
        ],
        "not_in": [
          "199.27.128.0/21",
          "2400:cb00::/32"
        ]
      }
    },
    "value": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
  }
}
          user-api-tokens-token-details

          GET Token Details permission needed: com.cloudflare.api.token.read
          • free
          • pro
          • business
          • enterprise

          Get information about a specific token

          GET user/tokens/:identifier
          cURL (example)
          curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
          Response (example)
          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed17574386854bf78a67040be0a770b0",
    "name": "readonly token",
    "status": "active",
    "issued_on": "2018-07-01T05:20:00Z",
    "modified_on": "2018-07-02T05:20:00Z",
    "not_before": "2018-07-01T05:20:00Z",
    "expires_on": "2020-01-01T00:00:00Z",
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "effect": "allow",
        "resources": {
          "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
          "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
        },
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "name": "DNS Read"
          }
        ]
      }
    ],
    "condition": {
      "request.ip": {
        "in": [
          "199.27.128.0/21",
          "2400:cb00::/32"
        ],
        "not_in": [
          "199.27.128.0/21",
          "2400:cb00::/32"
        ]
      }
    }
  }
}
          user-api-tokens-update-token

          PUT Update Token permission needed: com.cloudflare.api.token.update
          • free
          • pro
          • business
          • enterprise

          Update an existing token

          PUT user/tokens/:identifier

          Optional parameters

          Name /typeDescription /exampleConstraints
          expires_on
          string (date-time)

          The expiration time on or after which the JWT MUST NOT be accepted for processing

          "2020-01-01T00:00:00Z"
            not_before
            string (date-time)

            The time before which the token MUST NOT be accepted for processing

            "2018-07-01T05:20:00Z"
              name
              string

              Token name

              "readonly token"
              • max length: 120
              policies
              array

              List of access policies assigned to the token

              [ { "id": "f267e341f3dd4697bd3b9f71dd96247f", "effect": "allow", "resources": { "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*", "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*" }, "permission_groups": [ { "id": "c8fed203ed3043cba015a93ad1616f1f", "name": "Zone Read" }, { "id": "82e64a83756745bbbb1c9c2701bf816b", "name": "DNS Read" } ] } ]
              An array with items in the following form:
                status
                string

                Status of the token

                "active"
                • valid values: active, disabled, expired
                issued_on
                string (date-time)

                The time on which the token was created

                "2018-07-01T05:20:00Z"
                • read only
                modified_on
                string (date-time)

                Last time the token was modified

                "2018-07-02T05:20:00Z"
                • read only
                id
                string

                Token identifier tag

                "ed17574386854bf78a67040be0a770b0"
                • max length: 32
                • read only
                condition
                object

                Defines the extra limitation on how and/or where the token can be used

                { "request.ip": { "in": [ "199.27.128.0/21", "2400:cb00::/32" ], "not_in": [ "199.27.128.0/21", "2400:cb00::/32" ] } }
                An object with the following properties:
                  cURL (example)
                  curl -X PUT "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
     -H "Content-Type: application/json" \
     --data '{"id":"ed17574386854bf78a67040be0a770b0","name":"readonly token","status":"active","issued_on":"2018-07-01T05:20:00Z","modified_on":"2018-07-02T05:20:00Z","not_before":"2018-07-01T05:20:00Z","expires_on":"2020-01-01T00:00:00Z","policies":[{"id":"f267e341f3dd4697bd3b9f71dd96247f","effect":"allow","resources":{"com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*","com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"},"permission_groups":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}]}],"condition":{"request.ip":{"in":["199.27.128.0/21","2400:cb00::/32"],"not_in":["199.27.128.0/21","2400:cb00::/32"]}}}'
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed17574386854bf78a67040be0a770b0",
    "name": "readonly token",
    "status": "active",
    "issued_on": "2018-07-01T05:20:00Z",
    "modified_on": "2018-07-02T05:20:00Z",
    "not_before": "2018-07-01T05:20:00Z",
    "expires_on": "2020-01-01T00:00:00Z",
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "effect": "allow",
        "resources": {
          "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*",
          "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*"
        },
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "name": "DNS Read"
          }
        ]
      }
    ],
    "condition": {
      "request.ip": {
        "in": [
          "199.27.128.0/21",
          "2400:cb00::/32"
        ],
        "not_in": [
          "199.27.128.0/21",
          "2400:cb00::/32"
        ]
      }
    }
  }
}
                  user-api-tokens-delete-token

                  DELETE Delete Token permission needed: com.cloudflare.api.token.delete
                  • free
                  • pro
                  • business
                  • enterprise

                  Destroy a token

                  DELETE user/tokens/:identifier
                  cURL (example)
                  curl -X DELETE "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                  user-api-tokens-roll-token

                  PUT Roll Token permission needed: com.cloudflare.api.token.update
                  • free
                  • pro
                  • business
                  • enterprise

                  Roll the token secret

                  PUT user/tokens/:identifier/value
                  cURL (example)
                  curl -X PUT "https://api.cloudflare.com/client/v4/user/tokens/ed17574386854bf78a67040be0a770b0/value" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T" \
     -H "Content-Type: application/json" \
     --data '{}'
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
}
                  user-api-tokens-verify-token

                  GET Verify Token
                  • free
                  • pro
                  • business
                  • enterprise

                  Test a token

                  GET user/tokens/verify
                  cURL (example)
                  curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/verify" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed17574386854bf78a67040be0a770b0",
    "status": "active",
    "not_before": "2018-07-01T05:20:00Z",
    "expires_on": "2020-01-01T00:00:00Z"
  }
}

                  Permission Groups

                  Named groups of permissions used for creating API Tokens access policies

                  permission-groups

                  Object definition

                  View properties and constraints defined on the object

                  Show definition

                  permission-groups-list-permission-groups

                  GET List Permission Groups permission needed: com.cloudflare.api.token.read
                  • free
                  • pro
                  • business
                  • enterprise

                  Find all available permission groups

                  GET user/tokens/permission_groups
                  cURL (example)
                  curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/permission_groups" \
     -H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "7cf72faf220841aabcfdfab81c43c4f6",
      "name": "Billing Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "9d24387c6e8544e2bc4024a03991339f",
      "name": "Load Balancing: Monitors and Pools Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "d2a1802cc9a34e30852f8b33869b2f3c",
      "name": "Load Balancing: Monitors and Pools Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "8b47d2786a534c08a1f94ee8f9f599ef",
      "name": "Workers KV Storage Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "f7f0eda5697f475c90846e879bab8666",
      "name": "Workers KV Storage Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "1a71c399035b4950a1bd1466bbe4f420",
      "name": "Workers Scripts Read",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    },
    {
      "id": "e086da7e2179491d91ee5f35b3ca210a",
      "name": "Workers Scripts Write",
      "scopes": [
        "com.cloudflare.api.account"
      ]
    }
  ]
}

                  User's Account Memberships

                  A list of memberships of accounts this user can access

                  user-s-account-memberships

                  Object definition

                  View properties and constraints defined on the object

                  Show definition

                  user-s-account-memberships-list-memberships

                  GET List Memberships

                  List memberships of accounts the user can access

                  GET memberships

                  Optional parameters

                  Name /typeDescription /exampleConstraints
                  status
                  string

                  Status of this membership

                  "accepted"
                  • valid values: accepted, pending, rejected
                  account.name
                  string

                  Account name

                  "Demo Account"
                  • max length: 100
                  page
                  number

                  Page number of paginated results

                  1
                  • default value: 1
                  • min value:1
                  per_page
                  number

                  Number of memberships per page

                  20
                  • default value: 20
                  • min value:5
                  • max value:50
                  order
                  string

                  Field to order memberships by

                  "status"
                  • valid values: id, account.name, status
                  direction
                  string

                  Direction to order memberships

                  "desc"
                  • valid values: asc, desc
                  cURL (example)
                  curl -X GET "https://api.cloudflare.com/client/v4/memberships?status=accepted&account.name=Demo Account&page=1&per_page=20&order=status&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "4536bcfad5faccb111b47003c79917fa",
      "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
      "status": "accepted",
      "account": {
        "id": "01a7362d577a6c3019a474fd6f485823",
        "name": "Demo Account",
        "settings": {
          "enforce_twofactor": false,
          "use_account_custom_ns_by_default": false
        },
        "created_on": "2014-03-01T12:21:02.0000Z"
      },
      "roles": [
        "Account Administrator"
      ],
      "permissions": {
        "analytics": {
          "read": true,
          "write": true
        },
        "billing": {
          "read": true,
          "write": true
        },
        "cache_purge": {
          "read": true,
          "write": true
        },
        "dns": {
          "read": true,
          "write": true
        },
        "dns_records": {
          "read": true,
          "write": true
        },
        "lb": {
          "read": true,
          "write": true
        },
        "logs": {
          "read": true,
          "write": true
        },
        "organization": {
          "read": true,
          "write": true
        },
        "ssl": {
          "read": true,
          "write": true
        },
        "waf": {
          "read": true,
          "write": true
        },
        "zones": {
          "read": true,
          "write": true
        },
        "zone_settings": {
          "read": true,
          "write": true
        }
      }
    }
  ]
}
                  user-s-account-memberships-membership-details

                  GET Membership Details

                  Get a specific membership

                  GET memberships/:identifier
                  cURL (example)
                  curl -X GET "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
    "status": "accepted",
    "account": {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Demo Account",
      "settings": {
        "enforce_twofactor": false,
        "use_account_custom_ns_by_default": false
      },
      "created_on": "2014-03-01T12:21:02.0000Z"
    },
    "roles": [
      "Account Administrator"
    ],
    "permissions": {
      "analytics": {
        "read": true,
        "write": true
      },
      "billing": {
        "read": true,
        "write": true
      },
      "cache_purge": {
        "read": true,
        "write": true
      },
      "dns": {
        "read": true,
        "write": true
      },
      "dns_records": {
        "read": true,
        "write": true
      },
      "lb": {
        "read": true,
        "write": true
      },
      "logs": {
        "read": true,
        "write": true
      },
      "organization": {
        "read": true,
        "write": true
      },
      "ssl": {
        "read": true,
        "write": true
      },
      "waf": {
        "read": true,
        "write": true
      },
      "zones": {
        "read": true,
        "write": true
      },
      "zone_settings": {
        "read": true,
        "write": true
      }
    }
  }
}
                  user-s-account-memberships-update-membership

                  PUT Update Membership

                  Accept or reject this account invitation

                  PUT memberships/:identifier

                  Required parameters

                  Name /typeDescription /exampleConstraints
                  status
                  string

                  Whether to accept or reject this account invitation

                  "accepted"
                  • valid values: accepted, rejected
                  cURL (example)
                  curl -X PUT "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"status":"accepted"}'
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
    "status": "accepted",
    "account": {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Demo Account",
      "settings": {
        "enforce_twofactor": false,
        "use_account_custom_ns_by_default": false
      },
      "created_on": "2014-03-01T12:21:02.0000Z"
    },
    "roles": [
      "Account Administrator"
    ],
    "permissions": {
      "analytics": {
        "read": true,
        "write": true
      },
      "billing": {
        "read": true,
        "write": true
      },
      "cache_purge": {
        "read": true,
        "write": true
      },
      "dns": {
        "read": true,
        "write": true
      },
      "dns_records": {
        "read": true,
        "write": true
      },
      "lb": {
        "read": true,
        "write": true
      },
      "logs": {
        "read": true,
        "write": true
      },
      "organization": {
        "read": true,
        "write": true
      },
      "ssl": {
        "read": true,
        "write": true
      },
      "waf": {
        "read": true,
        "write": true
      },
      "zones": {
        "read": true,
        "write": true
      },
      "zone_settings": {
        "read": true,
        "write": true
      }
    }
  }
}
                  user-s-account-memberships-delete-membership

                  DELETE Delete Membership

                  Remove the associated member from an account

                  DELETE memberships/:identifier
                  cURL (example)
                  curl -X DELETE "https://api.cloudflare.com/client/v4/memberships/4536bcfad5faccb111b47003c79917fa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa"
  }
}

                  User's Account Memberships error codes

                  CodeDescription
                  1000An unknown error(<CODE>) has occurred
                  1001Invalid request
                  1002Forbidden
                  1003Membership not found

                  Accounts

                  An Account is the root object which owns other resources such as zones, load balancers and billing details.

                  accounts

                  Object definition

                  View properties and constraints defined on the object

                  Show definition

                  accounts-list-accounts

                  GET List Accounts permission needed: #organization:read
                  • free
                  • pro
                  • business
                  • enterprise

                  List all accounts you have ownership or verified access to

                  GET accounts

                  Optional parameters

                  Name /typeDescription /exampleConstraints
                  page
                  number

                  Page number of paginated results

                  1
                  • default value: 1
                  • min value:1
                  per_page
                  number

                  Maximum number of results per page

                  20
                  • default value: 20
                  • min value:5
                  • max value:50
                  direction
                  string

                  Direction to order results

                  "desc"
                  • valid values: asc, desc
                  cURL (example)
                  curl -X GET "https://api.cloudflare.com/client/v4/accounts?page=1&per_page=20&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Demo Account",
      "settings": {
        "enforce_twofactor": false,
        "use_account_custom_ns_by_default": false
      },
      "created_on": "2014-03-01T12:21:02.0000Z"
    }
  ]
}
                  accounts-account-details

                  GET Account Details permission needed: #organization:read
                  • free
                  • pro
                  • business
                  • enterprise

                  Get information about a specific account that you are a member of

                  GET accounts/:identifier
                  cURL (example)
                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                  Response (example)
                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "name": "Demo Account",
    "settings": {
      "enforce_twofactor": false,
      "use_account_custom_ns_by_default": false
    },
    "created_on": "2014-03-01T12:21:02.0000Z"
  }
}
                  accounts-update-account

                  PUT Update Account permission needed: #organization:edit
                  • free
                  • pro
                  • business
                  • enterprise

                  Update an existing Account

                  PUT accounts/:identifier

                  Optional parameters

                  Name /typeDescription /exampleConstraints
                  id
                  string

                  Account identifier tag

                  "01a7362d577a6c3019a474fd6f485823"
                  • max length: 32
                  • read only
                  name
                  string

                  Account name

                  "Demo Account"
                  • max length: 100
                  settings
                  object

                  Account settings

                  { "enforce_twofactor": false, "use_account_custom_ns_by_default": false }
                  An object with the following properties:
                    created_on
                    string (date-time)

                    describes when account was created

                    "2014-03-01T12:21:02.0000Z"
                    • read only
                    cURL (example)
                    curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"01a7362d577a6c3019a474fd6f485823","name":"Demo Account","settings":{"enforce_twofactor":false,"use_account_custom_ns_by_default":false},"created_on":"2014-03-01T12:21:02.0000Z"}'
                    Response (example)
                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "name": "Demo Account",
    "settings": {
      "enforce_twofactor": false,
      "use_account_custom_ns_by_default": false
    },
    "created_on": "2014-03-01T12:21:02.0000Z"
  }
}

                    Accounts error codes

                    CodeDescription
                    1000An unknown error(<CODE>) has occurred
                    1001Invalid request
                    1002Forbidden
                    1003Account not found

                    Account Members

                    An association between a Cloudflare user and an account

                    account-members

                    Object definition

                    View properties and constraints defined on the object

                    Show definition

                    account-members-list-members

                    GET List Members permission needed: #organization:read
                    • free
                    • pro
                    • business
                    • enterprise

                    List all members of an account

                    GET accounts/:account_identifier/members

                    Optional parameters

                    Name /typeDescription /exampleConstraints
                    page
                    number

                    Page number of paginated results

                    1
                    • default value: 1
                    • min value:1
                    per_page
                    number

                    Maximum number of results per page

                    20
                    • default value: 20
                    • min value:5
                    • max value:50
                    direction
                    string

                    Direction to order results

                    "desc"
                    • valid values: asc, desc
                    cURL (example)
                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members?page=1&per_page=20&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                    Response (example)
                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "4536bcfad5faccb111b47003c79917fa",
      "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
      "user": {
        "id": "7c5dae5552338874e5053f2534d2767a",
        "first_name": "John",
        "last_name": "Appleseed",
        "email": "user@example.com",
        "two_factor_authentication_enabled": false
      },
      "status": "accepted",
      "roles": [
        {
          "id": "3536bcfad5faccb999b47003c79917fb",
          "name": "Account Administrator",
          "description": "Administrative access to the entire Account",
          "permissions": {
            "analytics": {
              "read": true,
              "write": true
            },
            "billing": {
              "read": true,
              "write": true
            },
            "cache_purge": {
              "read": true,
              "write": true
            },
            "dns": {
              "read": true,
              "write": true
            },
            "dns_records": {
              "read": true,
              "write": true
            },
            "lb": {
              "read": true,
              "write": true
            },
            "logs": {
              "read": true,
              "write": true
            },
            "organization": {
              "read": true,
              "write": true
            },
            "ssl": {
              "read": true,
              "write": true
            },
            "waf": {
              "read": true,
              "write": true
            },
            "zones": {
              "read": true,
              "write": true
            },
            "zone_settings": {
              "read": true,
              "write": true
            }
          }
        }
      ]
    }
  ]
}
                    account-members-add-member

                    POST Add Member permission needed: #organization:edit
                    • free
                    • pro
                    • business
                    • enterprise

                    Add a user to the list of members for this account

                    POST accounts/:account_identifier/members

                    Required parameters

                    Name /typeDescription /exampleConstraints
                    email
                    string

                    Your contact email address

                    "user@example.com"
                    • max length: 90
                    roles
                    array

                    Array of roles associated with this member

                    [ "3536bcfad5faccb999b47003c79917fb" ]
                    An array with items in the following form:

                      Optional parameters

                      Name /typeDescription /exampleConstraints
                      status
                      string

                      A member's status in the account

                      "accepted"
                      • default value: pending
                      • valid values: accepted, pending
                      cURL (example)
                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"email":"user@example.com","status":"accepted","roles":["3536bcfad5faccb999b47003c79917fb"]}'
                      Response (example)
                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
    "user": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "first_name": "John",
      "last_name": "Appleseed",
      "email": "user@example.com",
      "two_factor_authentication_enabled": false
    },
    "status": "accepted",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Account Administrator",
        "description": "Administrative access to the entire Account",
        "permissions": {
          "analytics": {
            "read": true,
            "write": true
          },
          "billing": {
            "read": true,
            "write": true
          },
          "cache_purge": {
            "read": true,
            "write": true
          },
          "dns": {
            "read": true,
            "write": true
          },
          "dns_records": {
            "read": true,
            "write": true
          },
          "lb": {
            "read": true,
            "write": true
          },
          "logs": {
            "read": true,
            "write": true
          },
          "organization": {
            "read": true,
            "write": true
          },
          "ssl": {
            "read": true,
            "write": true
          },
          "waf": {
            "read": true,
            "write": true
          },
          "zones": {
            "read": true,
            "write": true
          },
          "zone_settings": {
            "read": true,
            "write": true
          }
        }
      }
    ]
  }
}
                      account-members-member-details

                      GET Member Details permission needed: #organization:read
                      • free
                      • pro
                      • business
                      • enterprise

                      Get information about a specific member of an account

                      GET accounts/:account_identifier/members/:identifier
                      cURL (example)
                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                      Response (example)
                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
    "user": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "first_name": "John",
      "last_name": "Appleseed",
      "email": "user@example.com",
      "two_factor_authentication_enabled": false
    },
    "status": "accepted",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Account Administrator",
        "description": "Administrative access to the entire Account",
        "permissions": {
          "analytics": {
            "read": true,
            "write": true
          },
          "billing": {
            "read": true,
            "write": true
          },
          "cache_purge": {
            "read": true,
            "write": true
          },
          "dns": {
            "read": true,
            "write": true
          },
          "dns_records": {
            "read": true,
            "write": true
          },
          "lb": {
            "read": true,
            "write": true
          },
          "logs": {
            "read": true,
            "write": true
          },
          "organization": {
            "read": true,
            "write": true
          },
          "ssl": {
            "read": true,
            "write": true
          },
          "waf": {
            "read": true,
            "write": true
          },
          "zones": {
            "read": true,
            "write": true
          },
          "zone_settings": {
            "read": true,
            "write": true
          }
        }
      }
    ]
  }
}
                      account-members-update-member

                      PUT Update Member permission needed: #organization:edit
                      • free
                      • pro
                      • business
                      • enterprise

                      Modify an account member

                      PUT accounts/:account_identifier/members/:identifier

                      Optional parameters

                      Name /typeDescription /exampleConstraints
                      id
                      string

                      Membership identifier tag

                      "4536bcfad5faccb111b47003c79917fa"
                      • max length: 32
                      • read only
                      code
                      string

                      The unique activation code for the account membership

                      "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0"
                      • max length: 64
                      • read only
                      user
                      object
                      { "id": "7c5dae5552338874e5053f2534d2767a", "first_name": "John", "last_name": "Appleseed", "email": "user@example.com", "two_factor_authentication_enabled": false }
                      An object with the following properties:
                      • read only
                      status
                      string

                      A member's status in the account

                      "accepted"
                      • valid values: accepted, pending, rejected
                      • read only
                      roles
                      array

                      Roles assigned to this member

                      [ { "id": "3536bcfad5faccb999b47003c79917fb", "name": "Account Administrator", "description": "Administrative access to the entire Account", "permissions": { "analytics": { "read": true, "write": true }, "billing": { "read": true, "write": true }, "cache_purge": { "read": true, "write": true }, "dns": { "read": true, "write": true }, "dns_records": { "read": true, "write": true }, "lb": { "read": true, "write": true }, "logs": { "read": true, "write": true }, "organization": { "read": true, "write": true }, "ssl": { "read": true, "write": true }, "waf": { "read": true, "write": true }, "zones": { "read": true, "write": true }, "zone_settings": { "read": true, "write": true } } } ]
                      An array with items in the following form:
                        cURL (example)
                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"4536bcfad5faccb111b47003c79917fa","code":"05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0","user":{"id":"7c5dae5552338874e5053f2534d2767a","first_name":"John","last_name":"Appleseed","email":"user@example.com","two_factor_authentication_enabled":false},"status":"accepted","roles":[{"id":"3536bcfad5faccb999b47003c79917fb","name":"Account Administrator","description":"Administrative access to the entire Account","permissions":{"analytics":{"read":true,"write":true},"billing":{"read":true,"write":true},"cache_purge":{"read":true,"write":true},"dns":{"read":true,"write":true},"dns_records":{"read":true,"write":true},"lb":{"read":true,"write":true},"logs":{"read":true,"write":true},"organization":{"read":true,"write":true},"ssl":{"read":true,"write":true},"waf":{"read":true,"write":true},"zones":{"read":true,"write":true},"zone_settings":{"read":true,"write":true}}}]}'
                        Response (example)
                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
    "user": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "first_name": "John",
      "last_name": "Appleseed",
      "email": "user@example.com",
      "two_factor_authentication_enabled": false
    },
    "status": "accepted",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Account Administrator",
        "description": "Administrative access to the entire Account",
        "permissions": {
          "analytics": {
            "read": true,
            "write": true
          },
          "billing": {
            "read": true,
            "write": true
          },
          "cache_purge": {
            "read": true,
            "write": true
          },
          "dns": {
            "read": true,
            "write": true
          },
          "dns_records": {
            "read": true,
            "write": true
          },
          "lb": {
            "read": true,
            "write": true
          },
          "logs": {
            "read": true,
            "write": true
          },
          "organization": {
            "read": true,
            "write": true
          },
          "ssl": {
            "read": true,
            "write": true
          },
          "waf": {
            "read": true,
            "write": true
          },
          "zones": {
            "read": true,
            "write": true
          },
          "zone_settings": {
            "read": true,
            "write": true
          }
        }
      }
    ]
  }
}
                        account-members-remove-member

                        DELETE Remove Member permission needed: #organization:edit
                        • free
                        • pro
                        • business
                        • enterprise

                        Remove a member from an account

                        DELETE accounts/:account_identifier/members/:identifier
                        cURL (example)
                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/members/4536bcfad5faccb111b47003c79917fa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                        Response (example)
                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}

                        Account Roles

                        A Role defines what permissions a Member of an Account has.

                        account-roles

                        Object definition

                        View properties and constraints defined on the object

                        Show definition

                        account-roles-list-roles

                        GET List Roles permission needed: #organization:read

                        Get all available roles for an account

                        GET accounts/:account_identifier/roles
                        cURL (example)
                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/roles" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                        Response (example)
                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "3536bcfad5faccb999b47003c79917fb",
      "name": "Account Administrator",
      "description": "Administrative access to the entire Account",
      "permissions": {
        "analytics": {
          "read": true,
          "write": true
        },
        "billing": {
          "read": true,
          "write": true
        },
        "cache_purge": {
          "read": true,
          "write": true
        },
        "dns": {
          "read": true,
          "write": true
        },
        "dns_records": {
          "read": true,
          "write": true
        },
        "lb": {
          "read": true,
          "write": true
        },
        "logs": {
          "read": true,
          "write": true
        },
        "organization": {
          "read": true,
          "write": true
        },
        "ssl": {
          "read": true,
          "write": true
        },
        "waf": {
          "read": true,
          "write": true
        },
        "zones": {
          "read": true,
          "write": true
        },
        "zone_settings": {
          "read": true,
          "write": true
        }
      }
    }
  ]
}
                        account-roles-role-details

                        GET Role Details permission needed: #organization:read

                        Get information about a specific role for an account

                        GET accounts/:account_identifier/roles/:identifier
                        cURL (example)
                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/roles/3536bcfad5faccb999b47003c79917fb" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                        Response (example)
                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3536bcfad5faccb999b47003c79917fb",
    "name": "Account Administrator",
    "description": "Administrative access to the entire Account",
    "permissions": {
      "analytics": {
        "read": true,
        "write": true
      },
      "billing": {
        "read": true,
        "write": true
      },
      "cache_purge": {
        "read": true,
        "write": true
      },
      "dns": {
        "read": true,
        "write": true
      },
      "dns_records": {
        "read": true,
        "write": true
      },
      "lb": {
        "read": true,
        "write": true
      },
      "logs": {
        "read": true,
        "write": true
      },
      "organization": {
        "read": true,
        "write": true
      },
      "ssl": {
        "read": true,
        "write": true
      },
      "waf": {
        "read": true,
        "write": true
      },
      "zones": {
        "read": true,
        "write": true
      },
      "zone_settings": {
        "read": true,
        "write": true
      }
    }
  }
}

                        Account Subscriptions

                        Listing of an account's subscriptions

                        account-subscriptions

                        Object definition

                        View properties and constraints defined on the object

                        Show definition

                        account-subscriptions-list-subscriptions

                        GET List Subscriptions permission needed: #billing:read
                        • free
                        • pro
                        • business
                        • enterprise

                        Lists all an account's subscriptions

                        GET accounts/:account_identifier/subscriptions
                        cURL (example)
                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                        Response (example)
                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "app": {
        "install_id": null
      },
      "id": "506e3185e9c882d175a2d0cb0093d9f2",
      "state": "Paid",
      "price": 20,
      "currency": "USD",
      "component_values": [
        {
          "name": "page_rules",
          "value": 20,
          "default": 5,
          "price": 5
        }
      ],
      "zone": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "example.com"
      },
      "frequency": "monthly",
      "rate_plan": {
        "id": "free",
        "public_name": "Business Plan",
        "currency": "USD",
        "scope": "zone",
        "sets": [
          {}
        ],
        "is_contract": false,
        "externally_managed": false
      },
      "current_period_end": "2014-03-31T12:20:00Z",
      "current_period_start": "2014-05-11T12:20:00Z"
    }
  ]
}
                        account-subscriptions-create-subscription

                        POST Create Subscription permission needed: #billing:read#billing:edit
                        • free
                        • pro
                        • business
                        • enterprise

                        Create an account subscription.

                        POST accounts/:account_identifier/subscriptions

                        Optional parameters

                        Name /typeDescription /exampleConstraints
                        app
                        { "install_id": null }
                        An object with the following properties:
                          current_period_end
                          string (date-time)

                          The end of the current period, and also when the next billing is due

                          "2014-03-31T12:20:00Z"
                          • read only
                          component_values
                          array

                          The list of add-ons subscribed to

                          [ { "name": "page_rules", "value": 20, "default": 5, "price": 5 } ]
                          An array with items in the following form:
                            rate_plan
                            object

                            The rate plan applied to the subscription

                            { "id": "free", "public_name": "Business Plan", "currency": "USD", "scope": "zone", "sets": [ {} ], "is_contract": false, "externally_managed": false }
                            An object with the following properties:
                              price
                              number

                              The price of the subscription that will be billed, in US dollars

                              20
                              • read only
                              current_period_start
                              string (date-time)

                              When the current billing period started, may be the same as InitialPeriodStart if this is the first period

                              "2014-05-11T12:20:00Z"
                              • read only
                              zone
                              object

                              A simple zone object. May have null properties if not a zone subscription.

                              { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "example.com" }
                              An object with the following properties:
                                currency
                                string

                                The monetary unit in which pricing information is displayed

                                "USD"
                                • read only
                                state
                                string

                                The state that the subscription is in

                                "Paid"
                                • valid values: Trial, Provisioned, Paid, AwaitingPayment, Cancelled, Failed, Expired
                                • read only
                                id
                                string

                                Subscription identifier tag

                                "506e3185e9c882d175a2d0cb0093d9f2"
                                • max length: 32
                                • read only
                                frequency
                                string

                                How often the subscription is renewed automatically

                                "monthly"
                                • valid values: weekly, monthly, quarterly, yearly
                                cURL (example)
                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'
                                Response (example)
                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "app": {
      "install_id": null
    },
    "id": "506e3185e9c882d175a2d0cb0093d9f2",
    "state": "Paid",
    "price": 20,
    "currency": "USD",
    "component_values": [
      {
        "name": "page_rules",
        "value": 20,
        "default": 5,
        "price": 5
      }
    ],
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "frequency": "monthly",
    "rate_plan": {
      "id": "free",
      "public_name": "Business Plan",
      "currency": "USD",
      "scope": "zone",
      "sets": [
        {}
      ],
      "is_contract": false,
      "externally_managed": false
    },
    "current_period_end": "2014-03-31T12:20:00Z",
    "current_period_start": "2014-05-11T12:20:00Z"
  }
}
                                account-subscriptions-update-subscription

                                PUT Update Subscription permission needed: #billing:read#billing:edit
                                • free
                                • pro
                                • business
                                • enterprise

                                Update an account subscriptions.

                                PUT accounts/:account_identifier/subscriptions/:subscription_identifier

                                Optional parameters

                                Name /typeDescription /exampleConstraints
                                app
                                { "install_id": null }
                                An object with the following properties:
                                  current_period_end
                                  string (date-time)

                                  The end of the current period, and also when the next billing is due

                                  "2014-03-31T12:20:00Z"
                                  • read only
                                  component_values
                                  array

                                  The list of add-ons subscribed to

                                  [ { "name": "page_rules", "value": 20, "default": 5, "price": 5 } ]
                                  An array with items in the following form:
                                    rate_plan
                                    object

                                    The rate plan applied to the subscription

                                    { "id": "free", "public_name": "Business Plan", "currency": "USD", "scope": "zone", "sets": [ {} ], "is_contract": false, "externally_managed": false }
                                    An object with the following properties:
                                      price
                                      number

                                      The price of the subscription that will be billed, in US dollars

                                      20
                                      • read only
                                      current_period_start
                                      string (date-time)

                                      When the current billing period started, may be the same as InitialPeriodStart if this is the first period

                                      "2014-05-11T12:20:00Z"
                                      • read only
                                      zone
                                      object

                                      A simple zone object. May have null properties if not a zone subscription.

                                      { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "example.com" }
                                      An object with the following properties:
                                        currency
                                        string

                                        The monetary unit in which pricing information is displayed

                                        "USD"
                                        • read only
                                        state
                                        string

                                        The state that the subscription is in

                                        "Paid"
                                        • valid values: Trial, Provisioned, Paid, AwaitingPayment, Cancelled, Failed, Expired
                                        • read only
                                        id
                                        string

                                        Subscription identifier tag

                                        "506e3185e9c882d175a2d0cb0093d9f2"
                                        • max length: 32
                                        • read only
                                        frequency
                                        string

                                        How often the subscription is renewed automatically

                                        "monthly"
                                        • valid values: weekly, monthly, quarterly, yearly
                                        cURL (example)
                                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'
                                        Response (example)
                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "app": {
      "install_id": null
    },
    "id": "506e3185e9c882d175a2d0cb0093d9f2",
    "state": "Paid",
    "price": 20,
    "currency": "USD",
    "component_values": [
      {
        "name": "page_rules",
        "value": 20,
        "default": 5,
        "price": 5
      }
    ],
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "frequency": "monthly",
    "rate_plan": {
      "id": "free",
      "public_name": "Business Plan",
      "currency": "USD",
      "scope": "zone",
      "sets": [
        {}
      ],
      "is_contract": false,
      "externally_managed": false
    },
    "current_period_end": "2014-03-31T12:20:00Z",
    "current_period_start": "2014-05-11T12:20:00Z"
  }
}
                                        account-subscriptions-delete-subscription

                                        DELETE Delete Subscription permission needed: #billing:edit

                                        Deletes an account's subscription

                                        DELETE accounts/:account_identifier/subscriptions/:subscription_identifier
                                        cURL (example)
                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                        Response (example)
                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "subscription_id": "506e3185e9c882d175a2d0cb0093d9f2"
  }
}

                                        Organizations

                                        An Organization is an entity which holds a set of zones for multiple users to interact with.

                                        Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.

                                        organizations

                                        Object definition

                                        View properties and constraints defined on the object

                                        Show definition

                                        Deprecation Warning

                                        End of life Date: February 4, 2020

                                        This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                        organizations-organization-details

                                        GET Organization Details permission needed: #organization:read
                                        • free
                                        • pro
                                        • business
                                        • enterprise

                                        Get information about a specific organization that you are a member of

                                        GET organizations/:identifier
                                        cURL (example)
                                        curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                        Response (example)
                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "name": "Cloudflare, Inc.",
    "members": [
      {
        "id": "7c5dae5552338874e5053f2534d2767a",
        "name": "John Smith",
        "email": "user@example.com",
        "status": "accepted",
        "roles": [
          {
            "id": "3536bcfad5faccb999b47003c79917fb",
            "name": "Organization Admin",
            "description": "Administrative access to the entire Organization",
            "permissions": [
              "#zones:read"
            ]
          }
        ]
      }
    ],
    "invites": [
      {
        "id": "4f5f0c14a2a41d5063dd301b2f829f04",
        "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
        "invited_member_email": "user@example.com",
        "organization_id": "5a7805061c76ada191ed06f989cc3dac",
        "organization_name": "Cloudflare, Inc.",
        "roles": [
          {
            "id": "3536bcfad5faccb999b47003c79917fb",
            "name": "Organization Admin",
            "description": "Administrative access to the entire Organization",
            "permissions": [
              "#zones:read"
            ]
          }
        ],
        "invited_by": "user@example.com",
        "invited_on": "2014-01-01T05:20:00Z",
        "expires_on": "2014-01-01T05:20:00Z",
        "organization_is_enforcing_twofactor": true,
        "status": "accepted"
      }
    ],
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ]
  }
}

                                        Deprecation Warning

                                        End of life Date: February 4, 2020

                                        This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                        organizations-edit-organization

                                        PATCH Edit Organization permission needed: #organization:edit
                                        • free
                                        • pro
                                        • business
                                        • enterprise

                                        Update an existing Organization

                                        PATCH organizations/:identifier

                                        Optional parameters

                                        Name /typeDescription /exampleConstraints
                                        name
                                        string

                                        Organization Name

                                        "Cloudflare, Inc."
                                        • max length: 100
                                        cURL (example)
                                        curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Cloudflare, Inc."}'
                                        Response (example)
                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "name": "Cloudflare, Inc.",
    "members": [
      {
        "id": "7c5dae5552338874e5053f2534d2767a",
        "name": "John Smith",
        "email": "user@example.com",
        "status": "accepted",
        "roles": [
          {
            "id": "3536bcfad5faccb999b47003c79917fb",
            "name": "Organization Admin",
            "description": "Administrative access to the entire Organization",
            "permissions": [
              "#zones:read"
            ]
          }
        ]
      }
    ],
    "invites": [
      {
        "id": "4f5f0c14a2a41d5063dd301b2f829f04",
        "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
        "invited_member_email": "user@example.com",
        "organization_id": "5a7805061c76ada191ed06f989cc3dac",
        "organization_name": "Cloudflare, Inc.",
        "roles": [
          {
            "id": "3536bcfad5faccb999b47003c79917fb",
            "name": "Organization Admin",
            "description": "Administrative access to the entire Organization",
            "permissions": [
              "#zones:read"
            ]
          }
        ],
        "invited_by": "user@example.com",
        "invited_on": "2014-01-01T05:20:00Z",
        "expires_on": "2014-01-01T05:20:00Z",
        "organization_is_enforcing_twofactor": true,
        "status": "accepted"
      }
    ],
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ]
  }
}

                                        Organization Invites

                                        Invitations to potential members that this organization has created

                                        Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.

                                        organization-invites

                                        Object definition

                                        View properties and constraints defined on the object

                                        Show definition

                                        Deprecation Warning

                                        End of life Date: February 4, 2020

                                        This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                        organization-invites-list-invitations

                                        GET List Invitations permission needed: #organization:read
                                        • free
                                        • pro
                                        • business
                                        • enterprise

                                        List all invitations associated with an organization

                                        GET organizations/:organization_identifier/invites
                                        cURL (example)
                                        curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                        Response (example)
                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "4f5f0c14a2a41d5063dd301b2f829f04",
      "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
      "invited_member_email": "user@example.com",
      "organization_id": "5a7805061c76ada191ed06f989cc3dac",
      "organization_name": "Cloudflare, Inc.",
      "roles": [
        {
          "id": "3536bcfad5faccb999b47003c79917fb",
          "name": "Organization Admin",
          "description": "Administrative access to the entire Organization",
          "permissions": [
            "#zones:read"
          ]
        }
      ],
      "invited_by": "user@example.com",
      "invited_on": "2014-01-01T05:20:00Z",
      "expires_on": "2014-01-01T05:20:00Z",
      "organization_is_enforcing_twofactor": true,
      "status": "accepted"
    }
  ]
}

                                        Deprecation Warning

                                        End of life Date: February 4, 2020

                                        This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                        organization-invites-create-invitation

                                        POST Create Invitation permission needed: #organization:edit
                                        • free
                                        • pro
                                        • business
                                        • enterprise

                                        Invite a User to become a Member of an Organization

                                        POST organizations/:organization_identifier/invites

                                        Required parameters

                                        Name /typeDescription /exampleConstraints
                                        invited_member_email
                                        string

                                        Email address of the user to be added to the Organization

                                        "user@example.com"
                                        • max length: 90
                                        roles
                                        array

                                        Array of Roles associated with the invited user

                                        [ { "id": "5a7805061c76ada191ed06f989cc3dac" }, { "id": "9a7806061c88ada191ed06f989cc3dac" } ]
                                        An array with items in the following form:

                                          Optional parameters

                                          Name /typeDescription /exampleConstraints
                                          auto_accept
                                          boolean

                                          When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.

                                          true
                                          • default value: false
                                          • valid values: (true,false)
                                          cURL (example)
                                          curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"invited_member_email":"user@example.com","roles":[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}],"auto_accept":true}'
                                          Response (example)
                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4f5f0c14a2a41d5063dd301b2f829f04",
    "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
    "invited_member_email": "user@example.com",
    "organization_id": "5a7805061c76ada191ed06f989cc3dac",
    "organization_name": "Cloudflare, Inc.",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ],
    "invited_by": "user@example.com",
    "invited_on": "2014-01-01T05:20:00Z",
    "expires_on": "2014-01-01T05:20:00Z",
    "organization_is_enforcing_twofactor": true,
    "status": "accepted"
  }
}

                                          Deprecation Warning

                                          End of life Date: February 4, 2020

                                          This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                          organization-invites-invitation-details

                                          GET Invitation Details permission needed: #organization:read
                                          • free
                                          • pro
                                          • business
                                          • enterprise

                                          Get the details of an invitation

                                          GET organizations/:organization_identifier/invites/:identifier
                                          cURL (example)
                                          curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                          Response (example)
                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4f5f0c14a2a41d5063dd301b2f829f04",
    "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
    "invited_member_email": "user@example.com",
    "organization_id": "5a7805061c76ada191ed06f989cc3dac",
    "organization_name": "Cloudflare, Inc.",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ],
    "invited_by": "user@example.com",
    "invited_on": "2014-01-01T05:20:00Z",
    "expires_on": "2014-01-01T05:20:00Z",
    "organization_is_enforcing_twofactor": true,
    "status": "accepted"
  }
}

                                          Deprecation Warning

                                          End of life Date: February 4, 2020

                                          This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                          organization-invites-edit-invitation-roles

                                          PATCH Edit Invitation Roles permission needed: #organization:edit
                                          • free
                                          • pro
                                          • business
                                          • enterprise

                                          Change the Roles of a Pending Invite

                                          PATCH organizations/:organization_identifier/invites/:identifier

                                          Optional parameters

                                          Name /typeDescription /exampleConstraints
                                          roles
                                          array

                                          Array of Roles associated with the invited user

                                          [ "3536bcfad5faccb999b47003c79917fb" ]
                                          An array with items in the following form:
                                            cURL (example)
                                            curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"roles":["3536bcfad5faccb999b47003c79917fb"]}'
                                            Response (example)
                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4f5f0c14a2a41d5063dd301b2f829f04",
    "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
    "invited_member_email": "user@example.com",
    "organization_id": "5a7805061c76ada191ed06f989cc3dac",
    "organization_name": "Cloudflare, Inc.",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ],
    "invited_by": "user@example.com",
    "invited_on": "2014-01-01T05:20:00Z",
    "expires_on": "2014-01-01T05:20:00Z",
    "organization_is_enforcing_twofactor": true,
    "status": "accepted"
  }
}

                                            Deprecation Warning

                                            End of life Date: February 4, 2020

                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                            organization-invites-cancel-invitation

                                            DELETE Cancel Invitation permission needed: #organization:edit
                                            • free
                                            • pro
                                            • business
                                            • enterprise

                                            Cancel an existing invitation

                                            DELETE organizations/:organization_identifier/invites/:identifier
                                            cURL (example)
                                            curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                            Response (example)
                                            {
  "id": "4f5f0c14a2a41d5063dd301b2f829f04"
}

                                            Organization Members

                                            A member is the association of a Cloudflare user with an Organization.

                                            Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.

                                            organization-members

                                            Object definition

                                            View properties and constraints defined on the object

                                            Show definition

                                            Deprecation Warning

                                            End of life Date: February 4, 2020

                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                            organization-members-list-members

                                            GET List Members permission needed: #organization:read
                                            • free
                                            • pro
                                            • business
                                            • enterprise

                                            List all members of a organization

                                            GET organizations/:organization_identifier/members
                                            cURL (example)
                                            curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                            Response (example)
                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "name": "John Smith",
      "email": "user@example.com",
      "status": "accepted",
      "roles": [
        {
          "id": "3536bcfad5faccb999b47003c79917fb",
          "name": "Organization Admin",
          "description": "Administrative access to the entire Organization",
          "permissions": [
            "#zones:read"
          ]
        }
      ]
    }
  ]
}

                                            Deprecation Warning

                                            End of life Date: February 4, 2020

                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                            organization-members-member-details

                                            GET Member Details permission needed: #organization:read
                                            • free
                                            • pro
                                            • business
                                            • enterprise

                                            Get information about a specific member of an organization

                                            GET organizations/:organization_identifier/members/:identifier
                                            cURL (example)
                                            curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                            Response (example)
                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7c5dae5552338874e5053f2534d2767a",
    "name": "John Smith",
    "email": "user@example.com",
    "status": "accepted",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ]
  }
}

                                            Deprecation Warning

                                            End of life Date: February 4, 2020

                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                            organization-members-edit-member-roles

                                            PATCH Edit Member Roles permission needed: #organization:edit
                                            • free
                                            • pro
                                            • business
                                            • enterprise

                                            Change the Roles of an Organization's Member

                                            PATCH organizations/:organization_identifier/members/:identifier

                                            Optional parameters

                                            Name /typeDescription /exampleConstraints
                                            roles
                                            array

                                            Array of Roles associated with this Member

                                            [ "3536bcfad5faccb999b47003c79917fb" ]
                                            An array with items in the following form:
                                              cURL (example)
                                              curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"roles":["3536bcfad5faccb999b47003c79917fb"]}'
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7c5dae5552338874e5053f2534d2767a",
    "name": "John Smith",
    "email": "user@example.com",
    "status": "accepted",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ]
  }
}

                                              Deprecation Warning

                                              End of life Date: February 4, 2020

                                              This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                              organization-members-remove-member

                                              DELETE Remove Member permission needed: #organization:edit
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Remove a member from an organization

                                              DELETE organizations/:organization_identifier/members/:identifier
                                              cURL (example)
                                              curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/members/7c5dae5552338874e5053f2534d2767a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "id": "7c5dae5552338874e5053f2534d2767a"
}

                                              Organization Roles

                                              A role defines what permissions a Member of an Organization has.

                                              Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.

                                              organization-roles

                                              Object definition

                                              View properties and constraints defined on the object

                                              Show definition

                                              Deprecation Warning

                                              End of life Date: February 4, 2020

                                              This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                              organization-roles-list-roles

                                              GET List Roles permission needed: #organization:read
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Get all available roles for an organization

                                              GET organizations/:organization_identifier/roles
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/roles" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "3536bcfad5faccb999b47003c79917fb",
      "name": "Organization Admin",
      "description": "Administrative access to the entire Organization",
      "permissions": [
        "#zones:read"
      ]
    }
  ]
}

                                              Deprecation Warning

                                              End of life Date: February 4, 2020

                                              This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                              organization-roles-role-details

                                              GET Role Details permission needed: #organization:read
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Get information about a specific role for an organization

                                              GET organizations/:organization_identifier/roles/:identifier
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/roles/3536bcfad5faccb999b47003c79917fb" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3536bcfad5faccb999b47003c79917fb",
    "name": "Organization Admin",
    "description": "Administrative access to the entire Organization",
    "permissions": [
      "#zones:read"
    ]
  }
}

                                              User's Invites

                                              Your pending invitations to organizations

                                              user-s-invites

                                              Object definition

                                              View properties and constraints defined on the object

                                              Show definition

                                              user-s-invites-list-invitations

                                              GET List Invitations
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              List all invitations associated with my user

                                              GET user/invites
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/invites" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "4f5f0c14a2a41d5063dd301b2f829f04",
      "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
      "invited_member_email": "user@example.com",
      "organization_id": "5a7805061c76ada191ed06f989cc3dac",
      "organization_name": "Cloudflare, Inc.",
      "roles": [
        {
          "id": "3536bcfad5faccb999b47003c79917fb",
          "name": "Organization Admin",
          "description": "Administrative access to the entire Organization",
          "permissions": [
            "#zones:read"
          ]
        }
      ],
      "invited_by": "user@example.com",
      "invited_on": "2014-01-01T05:20:00Z",
      "expires_on": "2014-01-01T05:20:00Z",
      "status": "accepted"
    }
  ]
}
                                              user-s-invites-invitation-details

                                              GET Invitation Details
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Get the details of an invitation

                                              GET user/invites/:identifier
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4f5f0c14a2a41d5063dd301b2f829f04",
    "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
    "invited_member_email": "user@example.com",
    "organization_id": "5a7805061c76ada191ed06f989cc3dac",
    "organization_name": "Cloudflare, Inc.",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ],
    "invited_by": "user@example.com",
    "invited_on": "2014-01-01T05:20:00Z",
    "expires_on": "2014-01-01T05:20:00Z",
    "status": "accepted"
  }
}
                                              user-s-invites-respond-to-invitation

                                              PATCH Respond to Invitation
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Respond to an invitation

                                              PATCH user/invites/:identifier

                                              Required parameters

                                              Name /typeDescription /exampleConstraints
                                              status

                                              Status of your response to the invitation (rejected or accepted)

                                              "accepted"
                                              • valid values: accepted, rejected
                                              cURL (example)
                                              curl -X PATCH "https://api.cloudflare.com/client/v4/user/invites/4f5f0c14a2a41d5063dd301b2f829f04" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"status":"accepted"}'
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4f5f0c14a2a41d5063dd301b2f829f04",
    "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
    "invited_member_email": "user@example.com",
    "organization_id": "5a7805061c76ada191ed06f989cc3dac",
    "organization_name": "Cloudflare, Inc.",
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "name": "Organization Admin",
        "description": "Administrative access to the entire Organization",
        "permissions": [
          "#zones:read"
        ]
      }
    ],
    "invited_by": "user@example.com",
    "invited_on": "2014-01-01T05:20:00Z",
    "expires_on": "2014-01-01T05:20:00Z",
    "status": "accepted"
  }
}

                                              User's Organizations

                                              A list of organizations this user is a member of

                                              Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.

                                              user-s-organizations

                                              Object definition

                                              View properties and constraints defined on the object

                                              Show definition

                                              user-s-organizations-list-organizations

                                              GET List Organizations
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              List organizations the user is associated with

                                              GET user/organizations

                                              Optional parameters

                                              Name /typeDescription /exampleConstraints
                                              status
                                              string

                                              Whether or not the user is a member of the organization or has an inivitation pending

                                              "member"
                                              • valid values: member, invited
                                              name
                                              string

                                              Organization Name

                                              "Cloudflare, Inc."
                                              • max length: 100
                                              page
                                              number

                                              Page number of paginated results

                                              1
                                              • default value: 1
                                              • min value:1
                                              per_page
                                              number

                                              Number of organizations per page

                                              20
                                              • default value: 20
                                              • min value:5
                                              • max value:50
                                              order
                                              string

                                              Field to order organizations by

                                              "status"
                                              • valid values: id, name, status
                                              direction
                                              string

                                              Direction to order organizations

                                              "desc"
                                              • valid values: asc, desc
                                              match
                                              string

                                              Whether to match all search requirements or at least one (any)

                                              "all"
                                              • default value: all
                                              • valid values: any, all
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/organizations?status=member&name=Cloudflare, Inc.&page=1&per_page=20&order=status&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Cloudflare, Inc.",
      "status": "member",
      "permissions": [
        "#zones:read"
      ],
      "roles": [
        "All Privileges - Super Administrator"
      ]
    }
  ]
}
                                              user-s-organizations-organization-details

                                              GET Organization Details
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Get a specific organization the user is associated with

                                              GET user/organizations/:identifier
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/organizations/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "name": "Cloudflare, Inc.",
    "status": "member",
    "permissions": [
      "#zones:read"
    ],
    "roles": [
      "All Privileges - Super Administrator"
    ]
  }
}
                                              user-s-organizations-leave-organization

                                              DELETE Leave Organization
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Remove association to an organization

                                              DELETE user/organizations/:identifier
                                              cURL (example)
                                              curl -X DELETE "https://api.cloudflare.com/client/v4/user/organizations/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "id": "01a7362d577a6c3019a474fd6f485823"
}

                                              User Billing Profile

                                              A user billing profile

                                              user-billing-profile

                                              Object definition

                                              View properties and constraints defined on the object

                                              Show definition

                                              user-billing-profile-billing-profile-details

                                              GET Billing Profile Details permission needed: #billing:read
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Access your billing profile object

                                              GET user/billing/profile
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/billing/profile" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0020c268dbf54e975e7fe8563df49d52",
    "first_name": "Bob",
    "last_name": "Smith",
    "address": "123 3rd St.",
    "address2": "Apt 123",
    "company": "Cloudflare",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "12345",
    "country": "US",
    "telephone": "+1 111-867-5309",
    "card_number": "xxxx-xxxx-xxxx-1234",
    "card_expiry_year": 2015,
    "card_expiry_month": 4,
    "vat": "aaa-123-987",
    "edited_on": "2014-03-01T12:21:02.0000Z",
    "created_on": "2014-03-01T12:21:02.0000Z"
  }
}

                                              User Billing History

                                              A user billing history

                                              user-billing-history

                                              Object definition

                                              View properties and constraints defined on the object

                                              Show definition

                                              user-billing-history-billing-history-details

                                              GET Billing History Details permission needed: #billing:read
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Access your billing history object

                                              GET user/billing/history

                                              Optional parameters

                                              Name /typeDescription /exampleConstraints
                                              page
                                              number

                                              Page number of paginated results

                                              1
                                              • default value: 1
                                              • min value:1
                                              per_page
                                              number

                                              Number of items per page

                                              20
                                              • default value: 20
                                              • min value:5
                                              • max value:50
                                              order
                                              string

                                              Field to order billing history by

                                              "occured_at"
                                              • valid values: type, occured_at, action
                                              type
                                              string

                                              The billing item type

                                              "charge"
                                              • max length: 30
                                              • read only
                                              occured_at
                                              string (date-time)

                                              When the billing item was created

                                              "2014-03-01T12:21:59.3456Z"
                                              • read only
                                              action
                                              string

                                              The billing item action

                                              "subscription"
                                              • max length: 30
                                              • read only
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/billing/history?page=1&per_page=20&order=occured_at&type=charge&occured_at=2014-03-01T12:21:59.3456Z&action=subscription" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "b69a9f3492637782896352daae219e7d",
      "type": "charge",
      "action": "subscription",
      "description": "The billing item description",
      "occurred_at": "2014-03-01T12:21:59.3456Z",
      "amount": 20.99,
      "currency": "USD",
      "zone": {
        "name": "example.com"
      }
    }
  ]
}

                                              User Subscription

                                              Listing of a user's subscriptions

                                              user-subscription

                                              Object definition

                                              View properties and constraints defined on the object

                                              Show definition

                                              user-subscription-get-user-subscriptions

                                              GET Get User Subscriptions permission needed: #billing:read

                                              Lists all a user's subscriptions

                                              GET user/subscriptions
                                              cURL (example)
                                              curl -X GET "https://api.cloudflare.com/client/v4/user/subscriptions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                              Response (example)
                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "app": {
        "install_id": null
      },
      "id": "506e3185e9c882d175a2d0cb0093d9f2",
      "state": "Paid",
      "price": 20,
      "currency": "USD",
      "component_values": [
        {
          "name": "page_rules",
          "value": 20,
          "default": 5,
          "price": 5
        }
      ],
      "zone": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "example.com"
      },
      "frequency": "monthly",
      "rate_plan": {
        "id": "free",
        "public_name": "Business Plan",
        "currency": "USD",
        "scope": "zone",
        "sets": [
          {}
        ],
        "is_contract": false,
        "externally_managed": false
      },
      "current_period_end": "2014-03-31T12:20:00Z",
      "current_period_start": "2014-05-11T12:20:00Z"
    }
  ]
}
                                              user-subscription-update-user-subscription

                                              PUT Update User Subscription permission needed: #billing:read#billing:edit
                                              • free
                                              • pro
                                              • business
                                              • enterprise

                                              Update a user subscriptions.

                                              PUT user/subscriptions/:identifier

                                              Optional parameters

                                              Name /typeDescription /exampleConstraints
                                              app
                                              { "install_id": null }
                                              An object with the following properties:
                                                current_period_end
                                                string (date-time)

                                                The end of the current period, and also when the next billing is due

                                                "2014-03-31T12:20:00Z"
                                                • read only
                                                component_values
                                                array

                                                The list of add-ons subscribed to

                                                [ { "name": "page_rules", "value": 20, "default": 5, "price": 5 } ]
                                                An array with items in the following form:
                                                  rate_plan
                                                  object

                                                  The rate plan applied to the subscription

                                                  { "id": "free", "public_name": "Business Plan", "currency": "USD", "scope": "zone", "sets": [ {} ], "is_contract": false, "externally_managed": false }
                                                  An object with the following properties:
                                                    price
                                                    number

                                                    The price of the subscription that will be billed, in US dollars

                                                    20
                                                    • read only
                                                    current_period_start
                                                    string (date-time)

                                                    When the current billing period started, may be the same as InitialPeriodStart if this is the first period

                                                    "2014-05-11T12:20:00Z"
                                                    • read only
                                                    zone
                                                    object

                                                    A simple zone object. May have null properties if not a zone subscription.

                                                    { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "example.com" }
                                                    An object with the following properties:
                                                      currency
                                                      string

                                                      The monetary unit in which pricing information is displayed

                                                      "USD"
                                                      • read only
                                                      state
                                                      string

                                                      The state that the subscription is in

                                                      "Paid"
                                                      • valid values: Trial, Provisioned, Paid, AwaitingPayment, Cancelled, Failed, Expired
                                                      • read only
                                                      id
                                                      string

                                                      Subscription identifier tag

                                                      "506e3185e9c882d175a2d0cb0093d9f2"
                                                      • max length: 32
                                                      • read only
                                                      frequency
                                                      string

                                                      How often the subscription is renewed automatically

                                                      "monthly"
                                                      • valid values: weekly, monthly, quarterly, yearly
                                                      cURL (example)
                                                      curl -X PUT "https://api.cloudflare.com/client/v4/user/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'
                                                      Response (example)
                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "app": {
      "install_id": null
    },
    "id": "506e3185e9c882d175a2d0cb0093d9f2",
    "state": "Paid",
    "price": 20,
    "currency": "USD",
    "component_values": [
      {
        "name": "page_rules",
        "value": 20,
        "default": 5,
        "price": 5
      }
    ],
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "frequency": "monthly",
    "rate_plan": {
      "id": "free",
      "public_name": "Business Plan",
      "currency": "USD",
      "scope": "zone",
      "sets": [
        {}
      ],
      "is_contract": false,
      "externally_managed": false
    },
    "current_period_end": "2014-03-31T12:20:00Z",
    "current_period_start": "2014-05-11T12:20:00Z"
  }
}
                                                      user-subscription-delete-user-subscription

                                                      DELETE Delete User Subscription permission needed: #billing:edit

                                                      Deletes a user's subscription

                                                      DELETE user/subscriptions/:identifier
                                                      cURL (example)
                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/user/subscriptions/506e3185e9c882d175a2d0cb0093d9f2" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                      Response (example)
                                                      {
  "subscription_id": "506e3185e9c882d175a2d0cb0093d9f2"
}

                                                      Account Billing Profile

                                                      Account's billing profile

                                                      account-billing-profile

                                                      Object definition

                                                      View properties and constraints defined on the object

                                                      Show definition

                                                      account-billing-profile-billing-profile-details

                                                      GET Billing Profile Details permission needed: #billing:read
                                                      • free
                                                      • pro
                                                      • business
                                                      • enterprise

                                                      Get the current billing profile for the account

                                                      GET accounts/:account_identifier/billing/profile
                                                      cURL (example)
                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/billing/profile" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                      Response (example)
                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0020c268dbf54e975e7fe8563df49d52",
    "first_name": "Bob",
    "last_name": "Smith",
    "address": "123 3rd St.",
    "address2": "Apt 123",
    "company": "Cloudflare",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "12345",
    "country": "US",
    "telephone": "+1 111-867-5309",
    "card_number": "xxxx-xxxx-xxxx-1234",
    "card_expiry_year": 2015,
    "card_expiry_month": 4,
    "vat": "aaa-123-987",
    "edited_on": "2014-03-01T12:21:02.0000Z",
    "created_on": "2014-03-01T12:21:02.0000Z"
  }
}

                                                      Zone Rate Plan

                                                      A zone rate plan from the billing service

                                                      zone-rate-plan

                                                      Object definition

                                                      View properties and constraints defined on the object

                                                      Show definition

                                                      zone-rate-plan-list-available-rate-plans

                                                      GET List Available Rate Plans permission needed: #billing:read
                                                      • free
                                                      • pro
                                                      • business
                                                      • enterprise

                                                      List all rate plans the zone can subscribe to.

                                                      GET zones/:zone_identifier/available_rate_plans
                                                      cURL (example)
                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_rate_plans" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                      Response (example)
                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "free",
      "name": "Free Plan",
      "currency": "USD",
      "duration": 1,
      "frequency": "monthly",
      "components": [
        {
          "name": "page_rules",
          "default": 5,
          "unit_price": 1
        }
      ]
    }
  ]
}
                                                      zone-rate-plan-list-available-plans

                                                      GET List Available Plans permission needed: #billing:read
                                                      • free
                                                      • pro
                                                      • business
                                                      • enterprise

                                                      List available plans the zone can subscribe to.

                                                      GET zones/:zone_identifier/available_plans
                                                      cURL (example)
                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_plans" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                      Response (example)
                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "9a7806061c88ada191ed06f989cc3dac",
      "name": "Free Plan",
      "currency": "USD",
      "frequency": "monthly",
      "price": 0,
      "is_subscribed": false,
      "can_subscribe": true,
      "legacy_id": "free",
      "legacy_discount": false,
      "externally_managed": false
    }
  ]
}
                                                      zone-rate-plan-available-plan-details

                                                      GET Available Plan Details permission needed: #billing:read
                                                      • free
                                                      • pro
                                                      • business
                                                      • enterprise

                                                      Details of an available plan that the zone can subscribe to.

                                                      GET zones/:zone_identifier/available_plans/:plan_identifier
                                                      cURL (example)
                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/available_plans/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                      Response (example)
                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "name": "Free Plan",
    "currency": "USD",
    "frequency": "monthly",
    "price": 0,
    "is_subscribed": false,
    "can_subscribe": true,
    "legacy_id": "free",
    "legacy_discount": false,
    "externally_managed": false
  }
}

                                                      Zone Subscription

                                                      A subscription associated with a zone containing plan and add-ons

                                                      zone-subscription

                                                      Object definition

                                                      View properties and constraints defined on the object

                                                      Show definition

                                                      zone-subscription-zone-subscription-details

                                                      GET Zone Subscription Details permission needed: #billing:read
                                                      • free
                                                      • pro
                                                      • business
                                                      • enterprise

                                                      Zone subscription details

                                                      GET zones/:identifier/subscription
                                                      cURL (example)
                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                      Response (example)
                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "app": {
      "install_id": null
    },
    "id": "506e3185e9c882d175a2d0cb0093d9f2",
    "state": "Paid",
    "price": 20,
    "currency": "USD",
    "component_values": [
      {
        "name": "page_rules",
        "value": 20,
        "default": 5,
        "price": 5
      }
    ],
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "frequency": "monthly",
    "rate_plan": {
      "id": "free",
      "public_name": "Business Plan",
      "currency": "USD",
      "scope": "zone",
      "sets": [
        {}
      ],
      "is_contract": false,
      "externally_managed": false
    },
    "current_period_end": "2014-03-31T12:20:00Z",
    "current_period_start": "2014-05-11T12:20:00Z"
  }
}
                                                      zone-subscription-update-zone-subscription

                                                      PUT Update Zone Subscription permission needed: #billing:read#billing:edit
                                                      • free
                                                      • pro
                                                      • business
                                                      • enterprise

                                                      Update Zone subscriptions. Either plan and add-ons

                                                      PUT zones/:identifier/subscription

                                                      Optional parameters

                                                      Name /typeDescription /exampleConstraints
                                                      app
                                                      { "install_id": null }
                                                      An object with the following properties:
                                                        current_period_end
                                                        string (date-time)

                                                        The end of the current period, and also when the next billing is due

                                                        "2014-03-31T12:20:00Z"
                                                        • read only
                                                        component_values
                                                        array

                                                        The list of add-ons subscribed to

                                                        [ { "name": "page_rules", "value": 20, "default": 5, "price": 5 } ]
                                                        An array with items in the following form:
                                                          rate_plan
                                                          object

                                                          The rate plan applied to the subscription

                                                          { "id": "free", "public_name": "Business Plan", "currency": "USD", "scope": "zone", "sets": [ {} ], "is_contract": false, "externally_managed": false }
                                                          An object with the following properties:
                                                            price
                                                            number

                                                            The price of the subscription that will be billed, in US dollars

                                                            20
                                                            • read only
                                                            current_period_start
                                                            string (date-time)

                                                            When the current billing period started, may be the same as InitialPeriodStart if this is the first period

                                                            "2014-05-11T12:20:00Z"
                                                            • read only
                                                            zone
                                                            object

                                                            A simple zone object. May have null properties if not a zone subscription.

                                                            { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "example.com" }
                                                            An object with the following properties:
                                                              currency
                                                              string

                                                              The monetary unit in which pricing information is displayed

                                                              "USD"
                                                              • read only
                                                              state
                                                              string

                                                              The state that the subscription is in

                                                              "Paid"
                                                              • valid values: Trial, Provisioned, Paid, AwaitingPayment, Cancelled, Failed, Expired
                                                              • read only
                                                              id
                                                              string

                                                              Subscription identifier tag

                                                              "506e3185e9c882d175a2d0cb0093d9f2"
                                                              • max length: 32
                                                              • read only
                                                              frequency
                                                              string

                                                              How often the subscription is renewed automatically

                                                              "monthly"
                                                              • valid values: weekly, monthly, quarterly, yearly
                                                              cURL (example)
                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'
                                                              Response (example)
                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "app": {
      "install_id": null
    },
    "id": "506e3185e9c882d175a2d0cb0093d9f2",
    "state": "Paid",
    "price": 20,
    "currency": "USD",
    "component_values": [
      {
        "name": "page_rules",
        "value": 20,
        "default": 5,
        "price": 5
      }
    ],
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "frequency": "monthly",
    "rate_plan": {
      "id": "free",
      "public_name": "Business Plan",
      "currency": "USD",
      "scope": "zone",
      "sets": [
        {}
      ],
      "is_contract": false,
      "externally_managed": false
    },
    "current_period_end": "2014-03-31T12:20:00Z",
    "current_period_start": "2014-05-11T12:20:00Z"
  }
}
                                                              zone-subscription-create-zone-subscription

                                                              POST Create Zone Subscription permission needed: #billing:read#billing:edit
                                                              • free
                                                              • pro
                                                              • business
                                                              • enterprise

                                                              Create a Zone subscriptions. Either plan or add-ons

                                                              POST zones/:identifier/subscription

                                                              Optional parameters

                                                              Name /typeDescription /exampleConstraints
                                                              app
                                                              { "install_id": null }
                                                              An object with the following properties:
                                                                current_period_end
                                                                string (date-time)

                                                                The end of the current period, and also when the next billing is due

                                                                "2014-03-31T12:20:00Z"
                                                                • read only
                                                                component_values
                                                                array

                                                                The list of add-ons subscribed to

                                                                [ { "name": "page_rules", "value": 20, "default": 5, "price": 5 } ]
                                                                An array with items in the following form:
                                                                  rate_plan
                                                                  object

                                                                  The rate plan applied to the subscription

                                                                  { "id": "free", "public_name": "Business Plan", "currency": "USD", "scope": "zone", "sets": [ {} ], "is_contract": false, "externally_managed": false }
                                                                  An object with the following properties:
                                                                    price
                                                                    number

                                                                    The price of the subscription that will be billed, in US dollars

                                                                    20
                                                                    • read only
                                                                    current_period_start
                                                                    string (date-time)

                                                                    When the current billing period started, may be the same as InitialPeriodStart if this is the first period

                                                                    "2014-05-11T12:20:00Z"
                                                                    • read only
                                                                    zone
                                                                    object

                                                                    A simple zone object. May have null properties if not a zone subscription.

                                                                    { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "example.com" }
                                                                    An object with the following properties:
                                                                      currency
                                                                      string

                                                                      The monetary unit in which pricing information is displayed

                                                                      "USD"
                                                                      • read only
                                                                      state
                                                                      string

                                                                      The state that the subscription is in

                                                                      "Paid"
                                                                      • valid values: Trial, Provisioned, Paid, AwaitingPayment, Cancelled, Failed, Expired
                                                                      • read only
                                                                      id
                                                                      string

                                                                      Subscription identifier tag

                                                                      "506e3185e9c882d175a2d0cb0093d9f2"
                                                                      • max length: 32
                                                                      • read only
                                                                      frequency
                                                                      string

                                                                      How often the subscription is renewed automatically

                                                                      "monthly"
                                                                      • valid values: weekly, monthly, quarterly, yearly
                                                                      cURL (example)
                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/506e3185e9c882d175a2d0cb0093d9f2/subscription" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"app":{"install_id":null},"id":"506e3185e9c882d175a2d0cb0093d9f2","state":"Paid","price":20,"currency":"USD","component_values":[{"name":"page_rules","value":20,"default":5,"price":5}],"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"frequency":"monthly","rate_plan":{"id":"free","public_name":"Business Plan","currency":"USD","scope":"zone","sets":[{}],"is_contract":false,"externally_managed":false},"current_period_end":"2014-03-31T12:20:00Z","current_period_start":"2014-05-11T12:20:00Z"}'
                                                                      Response (example)
                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "app": {
      "install_id": null
    },
    "id": "506e3185e9c882d175a2d0cb0093d9f2",
    "state": "Paid",
    "price": 20,
    "currency": "USD",
    "component_values": [
      {
        "name": "page_rules",
        "value": 20,
        "default": 5,
        "price": 5
      }
    ],
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "frequency": "monthly",
    "rate_plan": {
      "id": "free",
      "public_name": "Business Plan",
      "currency": "USD",
      "scope": "zone",
      "sets": [
        {}
      ],
      "is_contract": false,
      "externally_managed": false
    },
    "current_period_end": "2014-03-31T12:20:00Z",
    "current_period_start": "2014-05-11T12:20:00Z"
  }
}

                                                                      Audit Logs

                                                                      A log of changes made to your Cloudflare account

                                                                      audit-logs

                                                                      Object definition

                                                                      View properties and constraints defined on the object

                                                                      Show definition

                                                                      audit-logs-list-user-audit-logs

                                                                      GET List User Audit Logs
                                                                      • free
                                                                      • pro
                                                                      • business
                                                                      • enterprise

                                                                      Get audit logs for a user account, filter by who made the change, which zone was the change was made on, and the timeframe of the change

                                                                      GET user/audit_logs

                                                                      Optional parameters

                                                                      Name /typeDescription /exampleConstraints
                                                                      actor.ip
                                                                      string

                                                                      Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range

                                                                      "17.168.228.63"
                                                                        actor.email
                                                                        string (email)

                                                                        Filter by the email address of the actor that made the change

                                                                        "alice@example.com"
                                                                          zone.name
                                                                          string

                                                                          Filter by the name of the zone associated to the change.

                                                                          "example.com"
                                                                            page
                                                                            number

                                                                            Which page of results to return.

                                                                            50
                                                                            • default value: 1
                                                                            • min value:1
                                                                            per_page
                                                                            number

                                                                            How many results to return per page.

                                                                            25
                                                                            • default value: 100
                                                                            • min value:1
                                                                            • max value:1000
                                                                            action.type
                                                                            string

                                                                            Filter by the action type.

                                                                            "add"
                                                                              export
                                                                              boolean

                                                                              Indicates that this request is an export of logs in CSV format

                                                                              "true"
                                                                              • valid values: (true,false)
                                                                              since
                                                                              string (date-time)

                                                                              Limit the returned results to logs newer than the specified date. This can be a date string 2019-04-30 or an absolute timestamp that conforms to RFC3339

                                                                              "2019-04-30T01:12:20Z"
                                                                                id
                                                                                string

                                                                                Find a specific log by its ID.

                                                                                "f174be97-19b1-40d6-954d-70cd5fbd52db"
                                                                                  direction
                                                                                  string

                                                                                  Change the direction of the chronological sorting.

                                                                                  "desc"
                                                                                  • default value: desc
                                                                                  • valid values: desc, asc
                                                                                  before
                                                                                  string (date-time)

                                                                                  Limit the returned results to logs older than the specified date. This can be a date string 2019-04-30 or an absolute timestamp that conforms to RFC3339

                                                                                  "2019-04-30T01:12:20Z"
                                                                                    cURL (example)
                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/user/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                    Response (example)
                                                                                    {
  "success": true,
  "errors": null,
  "messages": [],
  "result": [
    {
      "id": "d5b0f326-1232-4452-8858-1089bd7168ef",
      "action": {
        "type": "change_setting",
        "result": true
      },
      "actor": {
        "id": "f6b5de0326bb5182b8a4840ee01ec774",
        "email": "michelle@example.com",
        "type": "user",
        "ip": "198.41.129.166"
      },
      "newValue": "low",
      "oldValue": "high",
      "owner": {
        "id": "7c5dae5552338874e5053f2534d2767a"
      },
      "resource": {
        "type": "zone",
        "id": "023e105f4ecef8ad9ca31a8372d0c353"
      },
      "interface": "API",
      "metadata": {
        "zone_name": "example.com",
        "type": "firewall",
        "name": "security_level",
        "value": "high"
      },
      "when": "2017-04-26T17:31:07Z"
    }
  ]
}
                                                                                    audit-logs-list-account-audit-logs

                                                                                    GET List Account Audit Logs
                                                                                    • free
                                                                                    • pro
                                                                                    • business
                                                                                    • enterprise

                                                                                    Get audit logs for an account, filter by who made the change, which zone was the change was made on, and the timeframe of the change

                                                                                    GET accounts/:account_identifier/audit_logs

                                                                                    Optional parameters

                                                                                    Name /typeDescription /exampleConstraints
                                                                                    actor.ip
                                                                                    string

                                                                                    Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range

                                                                                    "17.168.228.63"
                                                                                      actor.email
                                                                                      string (email)

                                                                                      Filter by the email address of the actor that made the change

                                                                                      "alice@example.com"
                                                                                        zone.name
                                                                                        string

                                                                                        Filter by the name of the zone associated to the change.

                                                                                        "example.com"
                                                                                          page
                                                                                          number

                                                                                          Which page of results to return.

                                                                                          50
                                                                                          • default value: 1
                                                                                          • min value:1
                                                                                          per_page
                                                                                          number

                                                                                          How many results to return per page.

                                                                                          25
                                                                                          • default value: 100
                                                                                          • min value:1
                                                                                          • max value:1000
                                                                                          action.type
                                                                                          string

                                                                                          Filter by the action type.

                                                                                          "add"
                                                                                            export
                                                                                            boolean

                                                                                            Indicates that this request is an export of logs in CSV format

                                                                                            "true"
                                                                                            • valid values: (true,false)
                                                                                            since
                                                                                            string (date-time)

                                                                                            Limit the returned results to logs newer than the specified date. This can be a date string 2019-04-30 or an absolute timestamp that conforms to RFC3339

                                                                                            "2019-04-30T01:12:20Z"
                                                                                              id
                                                                                              string

                                                                                              Find a specific log by its ID.

                                                                                              "f174be97-19b1-40d6-954d-70cd5fbd52db"
                                                                                                direction
                                                                                                string

                                                                                                Change the direction of the chronological sorting.

                                                                                                "desc"
                                                                                                • default value: desc
                                                                                                • valid values: desc, asc
                                                                                                before
                                                                                                string (date-time)

                                                                                                Limit the returned results to logs older than the specified date. This can be a date string 2019-04-30 or an absolute timestamp that conforms to RFC3339

                                                                                                "2019-04-30T01:12:20Z"
                                                                                                  cURL (example)
                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                  Response (example)
                                                                                                  {
  "success": true,
  "errors": null,
  "messages": [],
  "result": [
    {
      "id": "d5b0f326-1232-4452-8858-1089bd7168ef",
      "action": {
        "type": "change_setting",
        "result": true
      },
      "actor": {
        "id": "f6b5de0326bb5182b8a4840ee01ec774",
        "email": "michelle@example.com",
        "type": "user",
        "ip": "198.41.129.166"
      },
      "newValue": "low",
      "oldValue": "high",
      "owner": {
        "id": "7c5dae5552338874e5053f2534d2767a"
      },
      "resource": {
        "type": "zone",
        "id": "023e105f4ecef8ad9ca31a8372d0c353"
      },
      "interface": "API",
      "metadata": {
        "zone_name": "example.com",
        "type": "firewall",
        "name": "security_level",
        "value": "high"
      },
      "when": "2017-04-26T17:31:07Z"
    }
  ]
}

                                                                                                  Deprecation Warning

                                                                                                  End of life Date: February 4, 2020

                                                                                                  This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.

                                                                                                  audit-logs-list-organization-audit-logs

                                                                                                  GET List Organization Audit Logs
                                                                                                  • free
                                                                                                  • pro
                                                                                                  • business
                                                                                                  • enterprise

                                                                                                  Get audit logs for an organization, filter by who made the change, which zone was the change was made on, and the timeframe of the change

                                                                                                  GET organizations/:organization_identifier/audit_logs

                                                                                                  Optional parameters

                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                  actor.ip
                                                                                                  string

                                                                                                  Filter by the IP address of the request that made the change by specific IP address or valid CIDR Range

                                                                                                  "17.168.228.63"
                                                                                                    actor.email
                                                                                                    string (email)

                                                                                                    Filter by the email address of the actor that made the change

                                                                                                    "alice@example.com"
                                                                                                      zone.name
                                                                                                      string

                                                                                                      Filter by the name of the zone associated to the change.

                                                                                                      "example.com"
                                                                                                        page
                                                                                                        number

                                                                                                        Which page of results to return.

                                                                                                        50
                                                                                                        • default value: 1
                                                                                                        • min value:1
                                                                                                        per_page
                                                                                                        number

                                                                                                        How many results to return per page.

                                                                                                        25
                                                                                                        • default value: 100
                                                                                                        • min value:1
                                                                                                        • max value:1000
                                                                                                        action.type
                                                                                                        string

                                                                                                        Filter by the action type.

                                                                                                        "add"
                                                                                                          export
                                                                                                          boolean

                                                                                                          Indicates that this request is an export of logs in CSV format

                                                                                                          "true"
                                                                                                          • valid values: (true,false)
                                                                                                          since
                                                                                                          string (date-time)

                                                                                                          Limit the returned results to logs newer than the specified date. This can be a date string 2019-04-30 or an absolute timestamp that conforms to RFC3339

                                                                                                          "2019-04-30T01:12:20Z"
                                                                                                            id
                                                                                                            string

                                                                                                            Find a specific log by its ID.

                                                                                                            "f174be97-19b1-40d6-954d-70cd5fbd52db"
                                                                                                              direction
                                                                                                              string

                                                                                                              Change the direction of the chronological sorting.

                                                                                                              "desc"
                                                                                                              • default value: desc
                                                                                                              • valid values: desc, asc
                                                                                                              before
                                                                                                              string (date-time)

                                                                                                              Limit the returned results to logs older than the specified date. This can be a date string 2019-04-30 or an absolute timestamp that conforms to RFC3339

                                                                                                              "2019-04-30T01:12:20Z"
                                                                                                                cURL (example)
                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/audit_logs?id=f174be97-19b1-40d6-954d-70cd5fbd52db&export=true&action.type=add&actor.ip=17.168.228.63&actor.email=alice@example.com&since=2019-04-30T01:12:20Z&before=2019-04-30T01:12:20Z&zone.name=example.com&direction=desc&per_page=25&page=50" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                Response (example)
                                                                                                                {
  "success": true,
  "errors": null,
  "messages": [],
  "result": [
    {
      "id": "d5b0f326-1232-4452-8858-1089bd7168ef",
      "action": {
        "type": "change_setting",
        "result": true
      },
      "actor": {
        "id": "f6b5de0326bb5182b8a4840ee01ec774",
        "email": "michelle@example.com",
        "type": "user",
        "ip": "198.41.129.166"
      },
      "newValue": "low",
      "oldValue": "high",
      "owner": {
        "id": "7c5dae5552338874e5053f2534d2767a"
      },
      "resource": {
        "type": "zone",
        "id": "023e105f4ecef8ad9ca31a8372d0c353"
      },
      "interface": "API",
      "metadata": {
        "zone_name": "example.com",
        "type": "firewall",
        "name": "security_level",
        "value": "high"
      },
      "when": "2017-04-26T17:31:07Z"
    }
  ]
}

                                                                                                                Argo Smart Routing

                                                                                                                Query, enable and disable Argo smart routing for a zone.

                                                                                                                argo-smart-routing

                                                                                                                Object definition

                                                                                                                View properties and constraints defined on the object

                                                                                                                Show definition

                                                                                                                argo-smart-routing-get-argo-smart-routing-setting

                                                                                                                GET Get Argo Smart Routing setting permission needed: #argo:read
                                                                                                                • free
                                                                                                                • pro
                                                                                                                • business
                                                                                                                • enterprise

                                                                                                                GET zones/:zone_identifier/argo/smart_routing
                                                                                                                cURL (example)
                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/smart_routing" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                Response (example)
                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "smart_routing",
    "value": "on",
    "editable": true,
    "modified_on": "2019-02-20T22:37:07.107449Z"
  }
}
                                                                                                                argo-smart-routing-patch-argo-smart-routing-setting

                                                                                                                PATCH Patch Argo Smart Routing setting permission needed: #argo:read#argo:edit
                                                                                                                • free
                                                                                                                • pro
                                                                                                                • business
                                                                                                                • enterprise

                                                                                                                PATCH zones/:zone_identifier/argo/smart_routing

                                                                                                                Required parameters

                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                value
                                                                                                                string

                                                                                                                Enablement of Argo smart routing

                                                                                                                "on"
                                                                                                                • valid values: on, off
                                                                                                                cURL (example)
                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/argo/smart_routing" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                Response (example)
                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "smart_routing",
    "value": "on",
    "editable": true,
    "modified_on": "2019-02-20T22:37:07.107449Z"
  }
}

                                                                                                                Argo Analytics for Zone

                                                                                                                Argo Smart Routing Analytics for a zone

                                                                                                                argo-analytics-for-zone

                                                                                                                Object definition

                                                                                                                View properties and constraints defined on the object

                                                                                                                Show definition

                                                                                                                argo-analytics-for-zone-argo-analytics-for-a-zone

                                                                                                                GET Argo Analytics for a zone permission needed: #analytics:read
                                                                                                                • free
                                                                                                                • pro
                                                                                                                • business
                                                                                                                • enterprise

                                                                                                                GET zones/:zone_identifier/analytics/latency

                                                                                                                Optional parameters

                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                bins
                                                                                                                integer

                                                                                                                Number of buckets latency is split into

                                                                                                                3
                                                                                                                • min value:1
                                                                                                                • max value:1000
                                                                                                                cURL (example)
                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/latency?bins=3" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                Response (example)
                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "bins": 3,
    "range": {
      "min": 0,
      "max": 2500
    },
    "time_range": {
      "since": "2019-03-04T22:05:00Z",
      "until": "2019-03-06T22:05:00Z"
    },
    "data": {
      "labels": [
        "without_argo",
        "with_argo"
      ],
      "counts": [
        [
          3306,
          362,
          1267
        ],
        [
          30685,
          11775,
          42169
        ]
      ],
      "averages": [
        192,
        120
      ],
      "percent_smart_routed": 42.5
    }
  }
}

                                                                                                                Argo Analytics for Geolocation

                                                                                                                Argo Smart Routing Analytics for a zone at different PoPs

                                                                                                                argo-analytics-for-geolocation

                                                                                                                Object definition

                                                                                                                View properties and constraints defined on the object

                                                                                                                Show definition

                                                                                                                argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-differnt-pops

                                                                                                                GET Argo Analytics for a zone at differnt PoPs permission needed: #analytics:read
                                                                                                                • free
                                                                                                                • pro
                                                                                                                • business
                                                                                                                • enterprise

                                                                                                                GET zones/:zone_identifier/analytics/latency/colos
                                                                                                                cURL (example)
                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/latency/colos" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                Response (example)
                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "type": "FeatureCollection",
    "features": [
      {
        "properties": {
          "code": "ATL",
          "argo_req_count": 15644,
          "pct_avg_change": -0.38009502863254624,
          "no_argo_avg": 319.0564263322884,
          "argo_avg": 197.78466483011937
        },
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -84.44403,
            33.640068
          ]
        }
      }
    ]
  }
}

                                                                                                                Zone

                                                                                                                A Zone is a domain name along with its subdomains and other identities

                                                                                                                zone

                                                                                                                Object definition

                                                                                                                View properties and constraints defined on the object

                                                                                                                Show definition

                                                                                                                zone-list-zones

                                                                                                                GET List Zones permission needed: #zone:read
                                                                                                                • free
                                                                                                                • pro
                                                                                                                • business
                                                                                                                • enterprise

                                                                                                                List, search, sort, and filter your zones

                                                                                                                GET zones

                                                                                                                Optional parameters

                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                match
                                                                                                                string

                                                                                                                Whether to match all search requirements or at least one (any)

                                                                                                                "all"
                                                                                                                • default value: all
                                                                                                                • valid values: any, all
                                                                                                                name
                                                                                                                string (hostname)

                                                                                                                A domain name

                                                                                                                "example.com"
                                                                                                                • max length: 253
                                                                                                                account.name
                                                                                                                string

                                                                                                                Account name

                                                                                                                "Demo Account"
                                                                                                                • max length: 100
                                                                                                                order
                                                                                                                string

                                                                                                                Field to order zones by

                                                                                                                "status"
                                                                                                                • valid values: name, status, account.id, account.name
                                                                                                                page
                                                                                                                number

                                                                                                                Page number of paginated results

                                                                                                                1
                                                                                                                • default value: 1
                                                                                                                • min value:1
                                                                                                                per_page
                                                                                                                number

                                                                                                                Number of zones per page

                                                                                                                20
                                                                                                                • default value: 20
                                                                                                                • min value:5
                                                                                                                • max value:50
                                                                                                                status
                                                                                                                string

                                                                                                                Status of the zone

                                                                                                                "active"
                                                                                                                • valid values: active, pending, initializing, moved, deleted, deactivated
                                                                                                                • read only
                                                                                                                account.id
                                                                                                                string

                                                                                                                Account identifier tag

                                                                                                                "01a7362d577a6c3019a474fd6f485823"
                                                                                                                • max length: 32
                                                                                                                • read only
                                                                                                                direction
                                                                                                                string

                                                                                                                Direction to order zones

                                                                                                                "desc"
                                                                                                                • valid values: asc, desc
                                                                                                                cURL (example)
                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones?name=example.com&status=active&account.id=01a7362d577a6c3019a474fd6f485823&account.name=Demo Account&page=1&per_page=20&order=status&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                Response (example)
                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com",
      "development_mode": 7200,
      "original_name_servers": [
        "ns1.originaldnshost.com",
        "ns2.originaldnshost.com"
      ],
      "original_registrar": "GoDaddy",
      "original_dnshost": "NameCheap",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "activated_on": "2014-01-02T00:01:00.12345Z",
      "owner": {
        "id": {},
        "email": {},
        "type": "user"
      },
      "account": {
        "id": "01a7362d577a6c3019a474fd6f485823",
        "name": "Demo Account"
      },
      "permissions": [
        "#zone:read",
        "#zone:edit"
      ],
      "plan": {
        "id": "e592fd9519420ba7405e1307bff33214",
        "name": "Pro Plan",
        "price": 20,
        "currency": "USD",
        "frequency": "monthly",
        "legacy_id": "pro",
        "is_subscribed": true,
        "can_subscribe": true
      },
      "plan_pending": {
        "id": "e592fd9519420ba7405e1307bff33214",
        "name": "Pro Plan",
        "price": 20,
        "currency": "USD",
        "frequency": "monthly",
        "legacy_id": "pro",
        "is_subscribed": true,
        "can_subscribe": true
      },
      "status": "active",
      "paused": false,
      "type": "full",
      "name_servers": [
        "tony.ns.cloudflare.com",
        "woz.ns.cloudflare.com"
      ]
    }
  ]
}
                                                                                                                zone-create-zone

                                                                                                                POST Create Zone permission needed: #zone:edit
                                                                                                                • free
                                                                                                                • pro
                                                                                                                • business
                                                                                                                • enterprise

                                                                                                                POST zones

                                                                                                                Required parameters

                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                name
                                                                                                                string

                                                                                                                The domain name

                                                                                                                "example.com"
                                                                                                                • max length: 253
                                                                                                                • read only
                                                                                                                • pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
                                                                                                                account
                                                                                                                object

                                                                                                                Account of which the zone is created in

                                                                                                                { "id": "01a7362d577a6c3019a474fd6f485823" }
                                                                                                                An object with the following properties:

                                                                                                                  Optional parameters

                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                  jump_start
                                                                                                                  boolean

                                                                                                                  Automatically attempt to fetch existing DNS records

                                                                                                                  true
                                                                                                                  • default value: false
                                                                                                                  • valid values: (true,false)
                                                                                                                  type
                                                                                                                  string

                                                                                                                  A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.

                                                                                                                  "full"
                                                                                                                  • valid values: full, partial
                                                                                                                  cURL (example)
                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/zones" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"example.com","account":{"id":"01a7362d577a6c3019a474fd6f485823"},"jump_start":true,"type":"full"}'
                                                                                                                  Response (example)
                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "example.com",
    "development_mode": 7200,
    "original_name_servers": [
      "ns1.originaldnshost.com",
      "ns2.originaldnshost.com"
    ],
    "original_registrar": "GoDaddy",
    "original_dnshost": "NameCheap",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "activated_on": "2014-01-02T00:01:00.12345Z",
    "owner": {
      "id": {},
      "email": {},
      "type": "user"
    },
    "account": {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Demo Account"
    },
    "permissions": [
      "#zone:read",
      "#zone:edit"
    ],
    "plan": {
      "id": "e592fd9519420ba7405e1307bff33214",
      "name": "Pro Plan",
      "price": 20,
      "currency": "USD",
      "frequency": "monthly",
      "legacy_id": "pro",
      "is_subscribed": true,
      "can_subscribe": true
    },
    "plan_pending": {
      "id": "e592fd9519420ba7405e1307bff33214",
      "name": "Pro Plan",
      "price": 20,
      "currency": "USD",
      "frequency": "monthly",
      "legacy_id": "pro",
      "is_subscribed": true,
      "can_subscribe": true
    },
    "status": "active",
    "paused": false,
    "type": "full",
    "name_servers": [
      "tony.ns.cloudflare.com",
      "woz.ns.cloudflare.com"
    ]
  }
}
                                                                                                                  zone-zone-details

                                                                                                                  GET Zone Details permission needed: #zone:read
                                                                                                                  • free
                                                                                                                  • pro
                                                                                                                  • business
                                                                                                                  • enterprise

                                                                                                                  GET zones/:identifier
                                                                                                                  cURL (example)
                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                  Response (example)
                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "example.com",
    "development_mode": 7200,
    "original_name_servers": [
      "ns1.originaldnshost.com",
      "ns2.originaldnshost.com"
    ],
    "original_registrar": "GoDaddy",
    "original_dnshost": "NameCheap",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "activated_on": "2014-01-02T00:01:00.12345Z",
    "owner": {
      "id": {},
      "email": {},
      "type": "user"
    },
    "account": {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Demo Account"
    },
    "permissions": [
      "#zone:read",
      "#zone:edit"
    ],
    "plan": {
      "id": "e592fd9519420ba7405e1307bff33214",
      "name": "Pro Plan",
      "price": 20,
      "currency": "USD",
      "frequency": "monthly",
      "legacy_id": "pro",
      "is_subscribed": true,
      "can_subscribe": true
    },
    "plan_pending": {
      "id": "e592fd9519420ba7405e1307bff33214",
      "name": "Pro Plan",
      "price": 20,
      "currency": "USD",
      "frequency": "monthly",
      "legacy_id": "pro",
      "is_subscribed": true,
      "can_subscribe": true
    },
    "status": "active",
    "paused": false,
    "type": "full",
    "name_servers": [
      "tony.ns.cloudflare.com",
      "woz.ns.cloudflare.com"
    ]
  }
}
                                                                                                                  zone-edit-zone

                                                                                                                  PATCH Edit Zone
                                                                                                                  • free
                                                                                                                  • pro
                                                                                                                  • business
                                                                                                                  • enterprise

                                                                                                                  Only one zone property can be changed at a time

                                                                                                                  PATCH zones/:identifier

                                                                                                                  Optional parameters

                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                  paused
                                                                                                                  boolean

                                                                                                                  Indicates if the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits.

                                                                                                                  false
                                                                                                                  • default value: false
                                                                                                                  • valid values: (true,false)
                                                                                                                  • read only
                                                                                                                  vanity_name_servers
                                                                                                                  array

                                                                                                                  An array of domains used for custom name servers. This is only available for Business and Enterprise plans.

                                                                                                                  [ "ns1.example.com", "ns2.example.com" ]
                                                                                                                  An array with items in the following form:
                                                                                                                    plan
                                                                                                                    object

                                                                                                                    The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans

                                                                                                                    { "id": "e592fd9519420ba7405e1307bff33214" }
                                                                                                                    An object with the following properties:
                                                                                                                      type
                                                                                                                      string

                                                                                                                      A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone.

                                                                                                                      "full"
                                                                                                                      • valid values: full, partial
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"paused":false,"vanity_name_servers":["ns1.example.com","ns2.example.com"],"plan":{"id":"e592fd9519420ba7405e1307bff33214"},"type":"full"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "example.com",
    "development_mode": 7200,
    "original_name_servers": [
      "ns1.originaldnshost.com",
      "ns2.originaldnshost.com"
    ],
    "original_registrar": "GoDaddy",
    "original_dnshost": "NameCheap",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "activated_on": "2014-01-02T00:01:00.12345Z",
    "owner": {
      "id": {},
      "email": {},
      "type": "user"
    },
    "account": {
      "id": "01a7362d577a6c3019a474fd6f485823",
      "name": "Demo Account"
    },
    "permissions": [
      "#zone:read",
      "#zone:edit"
    ],
    "plan": {
      "id": "e592fd9519420ba7405e1307bff33214",
      "name": "Pro Plan",
      "price": 20,
      "currency": "USD",
      "frequency": "monthly",
      "legacy_id": "pro",
      "is_subscribed": true,
      "can_subscribe": true
    },
    "plan_pending": {
      "id": "e592fd9519420ba7405e1307bff33214",
      "name": "Pro Plan",
      "price": 20,
      "currency": "USD",
      "frequency": "monthly",
      "legacy_id": "pro",
      "is_subscribed": true,
      "can_subscribe": true
    },
    "status": "active",
    "paused": false,
    "type": "full",
    "name_servers": [
      "tony.ns.cloudflare.com",
      "woz.ns.cloudflare.com"
    ]
  }
}
                                                                                                                      zone-delete-zone

                                                                                                                      DELETE Delete Zone permission needed: #zone:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Delete an existing zone.

                                                                                                                      DELETE zones/:identifier
                                                                                                                      cURL (example)
                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                      zone-zone-activation-check

                                                                                                                      PUT Zone Activation Check permission needed: #zone:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Initiate another zone activation check

                                                                                                                      PUT zones/:identifier/activation_check
                                                                                                                      cURL (example)
                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/activation_check" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                      zone-purge-all-files

                                                                                                                      POST Purge All Files permission needed: #cache_purge:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Remove ALL files from Cloudflare's cache

                                                                                                                      POST zones/:identifier/purge_cache

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      purge_everything

                                                                                                                      A flag that indicates all resources in Cloudflare's cache should be removed. Note: This may have dramatic affects on your origin server load after performing this action.

                                                                                                                      true
                                                                                                                      • valid values: true
                                                                                                                      cURL (example)
                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"purge_everything":true}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                      zone-purge-files-by-url

                                                                                                                      POST Purge Files by URL permission needed: #cache_purge:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Granularly remove one or more files from Cloudflare's cache either by specifying URLs. All tiers can purge by URL, however, FREE can only purge 1000 URLs per minute.

                                                                                                                      To purge files with custom cache keys, include the headers used to compute the cache key as in the example. To purge files with ${geo} or ${devicetype} in their cache keys, include the CF-Device-Type or CF-IPCountry headers.

                                                                                                                      NB: When including the Origin header, be sure to include the scheme and hostname. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.

                                                                                                                      POST zones/:identifier/purge_cache

                                                                                                                      Optional parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      files
                                                                                                                      array

                                                                                                                      An array of URLs that should be removed from cache

                                                                                                                      [ "http://www.example.com/css/styles.css", { "url": "http://www.example.com/cat_picture.jpg", "headers": { "Origin": "https://www.cloudflare.com", "CF-IPCountry": "US", "CF-Device-Type": "desktop" } } ]
                                                                                                                      An array with items in the following form:
                                                                                                                      • max length: 30
                                                                                                                      cURL (example)
                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"files":["http://www.example.com/css/styles.css",{"url":"http://www.example.com/cat_picture.jpg","headers":{"Origin":"https://www.cloudflare.com","CF-IPCountry":"US","CF-Device-Type":"desktop"}}]}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                      zone-purge-files-by-cache-tags,-host-or-prefix

                                                                                                                      POST Purge Files by Cache-Tags, Host or Prefix permission needed: #cache_purge:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Granularly remove one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix.

                                                                                                                      NB: Cache-Tag, host and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.

                                                                                                                      POST zones/:identifier/purge_cache

                                                                                                                      Optional parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      tags
                                                                                                                      array

                                                                                                                      Any assets served with a Cache-Tag header that matches one of the provided values will be purged from the Cloudflare cache

                                                                                                                      [ "some-tag", "another-tag" ]
                                                                                                                      An array with items in the following form:
                                                                                                                      • max length: 30
                                                                                                                      hosts
                                                                                                                      array

                                                                                                                      Any assets at URLs with a host that matches one of the provided values will be purged from the Cloudflare cache

                                                                                                                      [ "www.example.com", "images.example.com" ]
                                                                                                                      An array with items in the following form:
                                                                                                                      • max length: 30
                                                                                                                      prefixes
                                                                                                                      array

                                                                                                                      Any assets at URLs that match the prefix will be purged from the Cloudflare cache. For instance, a.com/b will purge a.com/b/c/d.png but not a.com/bc.png. The prefixes a.com/b and a.com/b/c are redundant.

                                                                                                                      [ "www.example.com/foo", "images.example.com/bar/baz" ]
                                                                                                                      An array with items in the following form:
                                                                                                                      • max length: 30
                                                                                                                      cURL (example)
                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/purge_cache" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"tags":["some-tag","another-tag"],"hosts":["www.example.com","images.example.com"],"prefixes":["www.example.com/foo","images.example.com/bar/baz"]}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}

                                                                                                                      Zone error codes

                                                                                                                      CodeDescription
                                                                                                                      1000Invalid or missing user
                                                                                                                      1001Invalid zone identifier
                                                                                                                      1002Invalid domain
                                                                                                                      1003'jump_start' must be boolean
                                                                                                                      1006Invalid or missing zone
                                                                                                                      1008Invalid or missing Zone id
                                                                                                                      1010Bulk deal limit reached
                                                                                                                      1012Request must contain one of 'purge_everything', 'files', 'tags', 'hosts' or 'prefixes'
                                                                                                                      1013'purge_everything' must be true
                                                                                                                      1014'files', 'tags', 'hosts' or 'prefixes' must be an array
                                                                                                                      1015Unable to purge <url>
                                                                                                                      1016Unable to purge any urls
                                                                                                                      1017Unable to purge all
                                                                                                                      1018Invalid zone status
                                                                                                                      1019Zone is already paused
                                                                                                                      1020Invalid or missing zone
                                                                                                                      1021Invalid zone status
                                                                                                                      1022Zone is already unpaused
                                                                                                                      1023Invalid or missing zone
                                                                                                                      1049<domain> is not a registered domain
                                                                                                                      1050<domain> is currently being tasted. It is not currently a registered domain
                                                                                                                      1051Cloudflare is already hosting <domain>
                                                                                                                      1052An error has occurred and it has been logged. We will fix this problem promptly. We apologize for the inconvenience
                                                                                                                      1055Failed to disable <domain>
                                                                                                                      1056preserve_ini must be a boolean
                                                                                                                      1057Zone must be in 'initializing' status
                                                                                                                      1059Unable to delete zone
                                                                                                                      1061<domain> already exists
                                                                                                                      1064Not allowed to update zone step. Bad zone status
                                                                                                                      1065Not allowed to update zone step. Zone has already been set up
                                                                                                                      1066Could not promote zone to step 3
                                                                                                                      1067Invalid organization identifier passed in your organization variable
                                                                                                                      1068Permission denied
                                                                                                                      1069organization variable should be an organization object
                                                                                                                      1070This operation requires a Business or Enterprise account.
                                                                                                                      1071Vanity name server array expected.
                                                                                                                      1073A name server provided is in the wrong format.
                                                                                                                      1074Could not find a valid zone.
                                                                                                                      1075Vanity name server array count is invalid
                                                                                                                      1076Name servers have invalid IP addresses
                                                                                                                      1077Could not find a valid zone.
                                                                                                                      1078This zone has no valid vanity IPs.
                                                                                                                      1079This zone has no valid vanity name servers.
                                                                                                                      1080There is a conflict with one of the name servers.
                                                                                                                      1081There are no valid vanity name servers to disable.
                                                                                                                      1082Unable to purge '<url>'. You can only purge files for this zone
                                                                                                                      1083Unable to purge '<url>'. Rate limit reached. Please wait if you need to perform more operations
                                                                                                                      1084Unable to purge '<url>'.
                                                                                                                      1085Only one property can be updated at a time
                                                                                                                      1086Invalid property
                                                                                                                      1088Invalid/Missing Zone plan ID
                                                                                                                      1089Invalid/Missing Zone plan ID
                                                                                                                      1092Request cannot contain 'purge_everything' and any of 'files', 'tags', 'hosts' or 'prefixes'
                                                                                                                      1094Exceeded maximum amount of files that can be purged on a single request for your plan type.
                                                                                                                      1095Sorry, you do not have access to purge cache for that zone id or that zone id is invalid
                                                                                                                      1096This action is not available as your zone has been deactivated for a possible Terms of Service violation
                                                                                                                      1097This web property cannot be added to Cloudflare at this time. If you are an Enterprise customer, please contact your Customer Success Manager. Otherwise, please email abusereply@cloudflare.com with the name of the web property and a detailed explanation of your association with this web property.
                                                                                                                      1098This web property is temporarily restricted from being added to Cloudflare at this time. Please try again later, or contact Cloudflare Support with any questions.
                                                                                                                      1099We were unable to identify <domain> as a registered domain. Please ensure you are providing the root domain and not any subdomains (e.g., example.com, not subdomain.example.com)
                                                                                                                      1100Tag exceeds maximum length of 1024 characters
                                                                                                                      1101Exceeded maximum amount of 30 tags that can be purged on a single request
                                                                                                                      1102Unable to purge by tag, rate limit reached. Please wait if you need to perform more
                                                                                                                      1104Partial zone signup not allowed
                                                                                                                      1105This web property is temporarily restricted from being added to Cloudflare at this time. Please try again later, or contact Cloudflare Support with any questions.
                                                                                                                      1106Sorry, you are not allowed to create new zones. Please contact support.
                                                                                                                      1107Only enterprise zones can purge by tag.
                                                                                                                      1108Unable to update domain subscription. Please contact support for assistance.
                                                                                                                      1109Unable to update domain subscription. Please contact support for assistance.
                                                                                                                      1110Failed to lookup registrar and hosting information of <domain> at this time. Please contact Cloudflare Support or try again later.
                                                                                                                      1111Exceeded maximum amount of 30 hosts that can be purged on a single request
                                                                                                                      1112Only enterprise zones can purge by host
                                                                                                                      1113Unable to purge by host, rate limit reached. Please wait if you need to perform more operations.
                                                                                                                      1114Host exceeds maximum length of 200 characters
                                                                                                                      1115Invalid host
                                                                                                                      1116No prefixes were provided in the request. Must provide at least 1 prefixes.
                                                                                                                      1117Exceeded maximum amount of 30 prefixes that can be purged on a single request.
                                                                                                                      1118Empty prefix provided. Prefixes must not be empty.
                                                                                                                      1119URI scheme provided in prefix '<prefix>'. URI schemes must not be provided.
                                                                                                                      1120URI host was not provided in prefix '<prefix>'. Host must be provided in each prefix.
                                                                                                                      1121URI host in prefix '<prefix>' exceeds maximum length of 200 characters.
                                                                                                                      1122URI host in prefix '<prefix>' has a segment exceeding maximum length of 63 characters.
                                                                                                                      1123URI Query string was provided in prefix '<prefix>'. Query strings must not be provided.
                                                                                                                      1124URI fragment was provided in prefix '<prefix>'. Fragments must not be provided.
                                                                                                                      1125URI host in prefix '<prefix>' is not a domain. Host must be a valid domain or IPV4 address.
                                                                                                                      1126URI host in prefix '<prefix>' contains an invalid top level domain.
                                                                                                                      1127Invalid prefix '<prefix>'. Invalid Url.
                                                                                                                      1128Prefix '<prefix>' overlaps with another prefix. Prefixes must not be redundant.
                                                                                                                      1129Could not purge prefix '<prefix>'. Internal error.
                                                                                                                      1130Only enterprise zones can purge by prefix.
                                                                                                                      1131Unable to purge by prefix, rate limit reached. Please wait if you need to perform more operations
                                                                                                                      1132Unable to purge '<url>'. Resized images cannot be purged. Purge the original image instead.
                                                                                                                      1133Path too deep in '<prefix>', maximum path depth is 31.

                                                                                                                      Zone Settings

                                                                                                                      A Zone setting changes how the Zone works in relation to caching, security, or other features of Cloudflare

                                                                                                                      zone-settings

                                                                                                                      Object definitions

                                                                                                                      View properties and constraints defined on the object

                                                                                                                      Show definitions

                                                                                                                      zone-settings-get-all-zone-settings

                                                                                                                      GET Get all Zone settings permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Available settings for your user in relation to a zone

                                                                                                                      GET zones/:zone_identifier/settings
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                      zone-settings-get-advanced-ddos-setting

                                                                                                                      GET Get Advanced DDOS setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones

                                                                                                                      GET zones/:zone_identifier/settings/advanced_ddos
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/advanced_ddos" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "advanced_ddos",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-always-online-setting

                                                                                                                      GET Get Always Online setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      When enabled, Always Online will serve pages from our cache if your server is offline (https://support.cloudflare.com/hc/en-us/articles/200168006)

                                                                                                                      GET zones/:zone_identifier/settings/always_online
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_online" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "always_online",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-always-use-https-setting

                                                                                                                      GET Get Always Use HTTPS setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.

                                                                                                                      GET zones/:zone_identifier/settings/always_use_https
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_use_https" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-opportunistic-onion-setting

                                                                                                                      GET Get Opportunistic Onion setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.

                                                                                                                      GET zones/:zone_identifier/settings/opportunistic_onion
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_onion" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-orange-to-orange-o2o-

                                                                                                                      GET Get Orange to Orange (O2O) permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.

                                                                                                                      GET zones/:zone_identifier/settings/orange_to_orange
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/orange_to_orange" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "orange_to_orange",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-automatic-https-rewrites-setting

                                                                                                                      GET Get Automatic HTTPS Rewrites setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable the Automatic HTTPS Rewrites feature for this zone.

                                                                                                                      GET zones/:zone_identifier/settings/automatic_https_rewrites
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_https_rewrites" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-browser-cache-ttl-setting

                                                                                                                      GET Get Browser Cache TTL setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276)

                                                                                                                      GET zones/:zone_identifier/settings/browser_cache_ttl
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_cache_ttl" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "browser_cache_ttl",
    "value": 14400,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-browser-check-setting

                                                                                                                      GET Get Browser Check setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086)

                                                                                                                      GET zones/:zone_identifier/settings/browser_check
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_check" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "browser_check",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-cache-level-setting

                                                                                                                      GET Get Cache Level setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256)

                                                                                                                      GET zones/:zone_identifier/settings/cache_level
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/cache_level" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "cache_level",
    "value": "aggressive",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-challenge-ttl-setting

                                                                                                                      GET Get Challenge TTL setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136)

                                                                                                                      GET zones/:zone_identifier/settings/challenge_ttl
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/challenge_ttl" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "challenge_ttl",
    "value": 1800,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-development-mode-setting

                                                                                                                      GET Get Development Mode setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.

                                                                                                                      GET zones/:zone_identifier/settings/development_mode
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/development_mode" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "development_mode",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "time_remaining": 3600
  }
}
                                                                                                                      zone-settings-get-email-obfuscation-setting

                                                                                                                      GET Get Email Obfuscation setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016)

                                                                                                                      GET zones/:zone_identifier/settings/email_obfuscation
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/email_obfuscation" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "email_obfuscation",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-hotlink-protection-setting

                                                                                                                      GET Get Hotlink Protection setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026)

                                                                                                                      GET zones/:zone_identifier/settings/hotlink_protection
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/hotlink_protection" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "hotlink_protection",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-ip-geolocation-setting

                                                                                                                      GET Get IP Geolocation setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236)

                                                                                                                      GET zones/:zone_identifier/settings/ip_geolocation
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ip_geolocation" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ip_geolocation",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-ipv6-setting

                                                                                                                      GET Get IPv6 setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586)

                                                                                                                      GET zones/:zone_identifier/settings/ipv6
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ipv6" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ipv6",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-minify-setting

                                                                                                                      GET Get Minify setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Automatically minify certain assets for your website (https://support.cloudflare.com/hc/en-us/articles/200168196).

                                                                                                                      GET zones/:zone_identifier/settings/minify
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/minify" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "minify",
    "value": {
      "css": "off",
      "html": "off",
      "js": "off"
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-mobile-redirect-setting

                                                                                                                      GET Get Mobile Redirect setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Automatically redirect visitors on mobile devices to a mobile-optimized subdomain (https://support.cloudflare.com/hc/en-us/articles/200168336).

                                                                                                                      GET zones/:zone_identifier/settings/mobile_redirect
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mobile_redirect" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "mobile_redirect",
    "value": {
      "status": "off",
      "mobile_subdomain": "m",
      "strip_uri": false
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-mirage-setting

                                                                                                                      GET Get Mirage setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Automatically optimize image loading for website visitors on mobile devices (http://blog.cloudflare.com/mirage2-solving-mobile-speed).

                                                                                                                      GET zones/:zone_identifier/settings/mirage
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mirage" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "mirage",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-enable-error-pages-on-setting

                                                                                                                      GET Get Enable Error Pages On setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.

                                                                                                                      GET zones/:zone_identifier/settings/origin_error_page_pass_thru
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_error_page_pass_thru" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-opportunistic-encryption-setting

                                                                                                                      GET Get Opportunistic Encryption setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable the Opportunistic Encryption feature for this zone.

                                                                                                                      GET zones/:zone_identifier/settings/opportunistic_encryption
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_encryption" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "opportunistic_encryption",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-polish-setting

                                                                                                                      GET Get Polish setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Strips metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.

                                                                                                                      GET zones/:zone_identifier/settings/polish
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/polish" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "polish",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-webp-setting

                                                                                                                      GET Get WebP setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      When the client requesting the image supports the WebP image codec, Cloudflare will serve a WebP version of the image when WebP offers a performance advantage over the original image format.

                                                                                                                      GET zones/:zone_identifier/settings/webp
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/webp" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "webp",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-brotli-setting

                                                                                                                      GET Get Brotli setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      When the client requesting an asset supports the brotli compression algorithm, Cloudflare will serve a brotli compressed version of the asset.

                                                                                                                      GET zones/:zone_identifier/settings/brotli
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/brotli" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "brotli",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-prefetch-preload-setting

                                                                                                                      GET Get Prefetch Preload setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.

                                                                                                                      GET zones/:zone_identifier/settings/prefetch_preload
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/prefetch_preload" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-privacy-pass-setting

                                                                                                                      GET Get Privacy Pass setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass)

                                                                                                                      GET zones/:zone_identifier/settings/privacy_pass
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/privacy_pass" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "privacy_pass",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-response-buffering-setting

                                                                                                                      GET Get Response Buffering setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.

                                                                                                                      GET zones/:zone_identifier/settings/response_buffering
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/response_buffering" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-rocket-loader-setting

                                                                                                                      GET Get Rocket Loader setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Rocket Loader is a general-purpose asynchronous JavaScript optimisation which prioritises the rendering of your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP) and also the window.onload time (assuming there is JavaScript on the page), which can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. (https://support.cloudflare.com/hc/en-us/articles/200168056)

                                                                                                                      GET zones/:zone_identifier/settings/rocket_loader
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/rocket_loader" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "rocket_loader",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-security-header-hsts-setting

                                                                                                                      GET Get Security Header (HSTS) setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cloudflare security header for a zone.

                                                                                                                      GET zones/:zone_identifier/settings/security_header
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_header" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "security_header",
    "value": {
      "strict_transport_security": {
        "enabled": true,
        "max_age": 86400,
        "include_subdomains": true,
        "nosniff": true
      }
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-security-level-setting

                                                                                                                      GET Get Security Level setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056)

                                                                                                                      GET zones/:zone_identifier/settings/security_level
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_level" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "security_level",
    "value": "medium",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-server-side-exclude-setting

                                                                                                                      GET Get Server Side Exclude setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036)

                                                                                                                      GET zones/:zone_identifier/settings/server_side_exclude
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/server_side_exclude" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "server_side_exclude",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-enable-query-string-sort-setting

                                                                                                                      GET Get Enable Query String Sort setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.

                                                                                                                      GET zones/:zone_identifier/settings/sort_query_string_for_cache
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/sort_query_string_for_cache" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-ssl-setting

                                                                                                                      GET Get SSL setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416)

                                                                                                                      GET zones/:zone_identifier/settings/ssl
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ssl",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-ssl/tls-recommender-enrollment

                                                                                                                      GET Get SSL/TLS Recommender enrollment permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.

                                                                                                                      GET zones/:zone_identifier/settings/ssl_recommender
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl_recommender" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ssl_recommender",
    "enabled": false,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-minimum-tls-version-setting

                                                                                                                      GET Get Minimum TLS Version setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Only accept HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.

                                                                                                                      GET zones/:zone_identifier/settings/min_tls_version
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/min_tls_version" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "1.0"
}
                                                                                                                      zone-settings-get-ciphers-setting

                                                                                                                      GET Get Ciphers setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.

                                                                                                                      GET zones/:zone_identifier/settings/ciphers
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ciphers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": []
}
                                                                                                                      zone-settings-get-zone-enable-tls-1.3-setting

                                                                                                                      GET Get Zone Enable TLS 1.3 setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable Crypto TLS 1.3 feature for this zone.

                                                                                                                      GET zones/:zone_identifier/settings/tls_1_3
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_1_3" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-tls-client-auth-setting

                                                                                                                      GET Get TLS Client Auth setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only)

                                                                                                                      GET zones/:zone_identifier/settings/tls_client_auth
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_client_auth" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "tls_client_auth",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-true-client-ip-setting

                                                                                                                      GET Get True Client IP setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.

                                                                                                                      GET zones/:zone_identifier/settings/true_client_ip_header
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/true_client_ip_header" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-get-proxy-read-timeout-setting

                                                                                                                      GET Get Proxy Read Timeout setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Maximum time between two read operations from origin

                                                                                                                      GET zones/:zone_identifier/settings/proxy_read_timeout
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/proxy_read_timeout" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "proxy_read_timeout",
    "value": 100,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-web-application-firewall-waf-setting

                                                                                                                      GET Get Web Application Firewall (WAF) setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016)

                                                                                                                      GET zones/:zone_identifier/settings/waf
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/waf" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "waf",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-http2-setting

                                                                                                                      GET Get HTTP2 setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Value of the HTTP2 setting

                                                                                                                      GET zones/:zone_identifier/settings/http2
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http2" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "http2",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-http3-setting

                                                                                                                      GET Get HTTP3 setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Value of the HTTP3 setting

                                                                                                                      GET zones/:zone_identifier/settings/http3
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http3" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "http3",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-0-rtt-session-resumption-setting

                                                                                                                      GET Get 0-RTT session resumption setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Value of the 0-RTT setting

                                                                                                                      GET zones/:zone_identifier/settings/0rtt
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/0rtt" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0rtt",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-pseudo-ipv4-setting

                                                                                                                      GET Get Pseudo IPv4 setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Value of the Pseudo IPv4 setting

                                                                                                                      GET zones/:zone_identifier/settings/pseudo_ipv4
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/pseudo_ipv4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "pseudo_ipv4",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-websockets-setting

                                                                                                                      GET Get WebSockets setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. (https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-)

                                                                                                                      GET zones/:zone_identifier/settings/websockets
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/websockets" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "websockets",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-image-resizing-setting

                                                                                                                      GET Get Image Resizing setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. (https://developers.cloudflare.com/images/)

                                                                                                                      GET zones/:zone_identifier/settings/image_resizing
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/image_resizing" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "image_resizing",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-http/2-edge-prioritization-setting

                                                                                                                      GET Get HTTP/2 Edge Prioritization setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.

                                                                                                                      GET zones/:zone_identifier/settings/h2_prioritization
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/h2_prioritization" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "h2_prioritization",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-get-automatic-platform-optimization-for-wordpress-setting

                                                                                                                      GET Get Automatic Platform Optimization for WordPress setting permission needed: #zone_settings:read
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare's edge network and caches third party fonts.

                                                                                                                      GET zones/:zone_identifier/settings/automatic_platform_optimization
                                                                                                                      cURL (example)
                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_platform_optimization" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "automatic_platform_optimization",
    "value": {
      "enabled": true,
      "cf": true,
      "wordpress": true,
      "wp_plugin": true,
      "hostnames": [
        "www.example.com",
        "example.com",
        "shop.example.com"
      ],
      "cache_by_device_type": false
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-edit-zone-settings-info

                                                                                                                      PATCH Edit zone settings info permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Edit settings for a zone

                                                                                                                      PATCH zones/:zone_identifier/settings

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      items
                                                                                                                      array

                                                                                                                      One or more zone setting objects. Must contain an ID and a value.

                                                                                                                      [ { "id": "always_online", "value": "on" }, { "id": "browser_cache_ttl", "value": 18000 }, { "id": "ip_geolocation", "value": "off" } ]
                                                                                                                      An array with items in the following form:
                                                                                                                      • min items: 1
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"items":[{"id":"always_online","value":"on"},{"id":"browser_cache_ttl","value":18000},{"id":"ip_geolocation","value":"off"}]}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                      zone-settings-change-always-online-setting

                                                                                                                      PATCH Change Always Online setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      When enabled, Always Online will serve pages from our cache if your server is offline (https://support.cloudflare.com/hc/en-us/articles/200168006)

                                                                                                                      PATCH zones/:zone_identifier/settings/always_online

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "on"
                                                                                                                      • default value: on
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_online" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "always_online",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-always-use-https-setting

                                                                                                                      PATCH Change Always Use HTTPS setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.

                                                                                                                      PATCH zones/:zone_identifier/settings/always_use_https

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/always_use_https" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-change-opportunistic-onion-setting

                                                                                                                      PATCH Change Opportunistic Onion setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.

                                                                                                                      PATCH zones/:zone_identifier/settings/opportunistic_onion

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: on, off
                                                                                                                      • notes: Default value depends on the zone's plan level.
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_onion" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-change-orange-to-orange-o2o-

                                                                                                                      PATCH Change Orange to Orange (O2O) permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.

                                                                                                                      PATCH zones/:zone_identifier/settings/orange_to_orange

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "on"
                                                                                                                      • default value: on
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/orange_to_orange" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "orange_to_orange",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-automatic-https-rewrites-setting

                                                                                                                      PATCH Change Automatic HTTPS Rewrites setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable the Automatic HTTPS Rewrites feature for this zone.

                                                                                                                      PATCH zones/:zone_identifier/settings/automatic_https_rewrites

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "on"
                                                                                                                      • default value: on
                                                                                                                      • valid values: on, off
                                                                                                                      • notes: Default value depends on the zone's plan level.
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_https_rewrites" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-change-browser-cache-ttl-setting

                                                                                                                      PATCH Change Browser Cache TTL setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276)

                                                                                                                      PATCH zones/:zone_identifier/settings/browser_cache_ttl

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      number

                                                                                                                      Value of the zone setting

                                                                                                                      14400
                                                                                                                      • default value: 14400
                                                                                                                      • valid values: 0, 30, 60, 120, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000
                                                                                                                      • notes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers`
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_cache_ttl" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":14400}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "browser_cache_ttl",
    "value": 14400,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-browser-check-setting

                                                                                                                      PATCH Change Browser Check setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086)

                                                                                                                      PATCH zones/:zone_identifier/settings/browser_check

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "on"
                                                                                                                      • default value: on
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/browser_check" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "browser_check",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-cache-level-setting

                                                                                                                      PATCH Change Cache Level setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256)

                                                                                                                      PATCH zones/:zone_identifier/settings/cache_level

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "aggressive"
                                                                                                                      • default value: aggressive
                                                                                                                      • valid values: aggressive, basic, simplified
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/cache_level" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"aggressive"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "cache_level",
    "value": "aggressive",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-challenge-ttl-setting

                                                                                                                      PATCH Change Challenge TTL setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136)

                                                                                                                      PATCH zones/:zone_identifier/settings/challenge_ttl

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      number

                                                                                                                      Value of the zone setting

                                                                                                                      1800
                                                                                                                      • default value: 1800
                                                                                                                      • valid values: 300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000, 31536000
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/challenge_ttl" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":1800}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "challenge_ttl",
    "value": 1800,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-development-mode-setting

                                                                                                                      PATCH Change Development Mode setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.

                                                                                                                      PATCH zones/:zone_identifier/settings/development_mode

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/development_mode" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "development_mode",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "time_remaining": 3600
  }
}
                                                                                                                      zone-settings-change-email-obfuscation-setting

                                                                                                                      PATCH Change Email Obfuscation setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016)

                                                                                                                      PATCH zones/:zone_identifier/settings/email_obfuscation

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "on"
                                                                                                                      • default value: on
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/email_obfuscation" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "email_obfuscation",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-enable-error-pages-on-setting

                                                                                                                      PATCH Change Enable Error Pages On setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.

                                                                                                                      PATCH zones/:zone_identifier/settings/origin_error_page_pass_thru

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/origin_error_page_pass_thru" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-change-enable-query-string-sort-setting

                                                                                                                      PATCH Change Enable Query String Sort setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.

                                                                                                                      PATCH zones/:zone_identifier/settings/sort_query_string_for_cache

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/sort_query_string_for_cache" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                      zone-settings-change-hotlink-protection-setting

                                                                                                                      PATCH Change Hotlink Protection setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026)

                                                                                                                      PATCH zones/:zone_identifier/settings/hotlink_protection

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/hotlink_protection" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "hotlink_protection",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-ip-geolocation-setting

                                                                                                                      PATCH Change IP Geolocation setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236)

                                                                                                                      PATCH zones/:zone_identifier/settings/ip_geolocation

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "on"
                                                                                                                      • default value: on
                                                                                                                      • valid values: on, off
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ip_geolocation" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ip_geolocation",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-ipv6-setting

                                                                                                                      PATCH Change IPv6 setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586)

                                                                                                                      PATCH zones/:zone_identifier/settings/ipv6

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      string

                                                                                                                      Value of the zone setting

                                                                                                                      "off"
                                                                                                                      • default value: off
                                                                                                                      • valid values: off, on
                                                                                                                      cURL (example)
                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ipv6" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                      Response (example)
                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ipv6",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                      zone-settings-change-minify-setting

                                                                                                                      PATCH Change Minify setting permission needed: #zone_settings:edit
                                                                                                                      • free
                                                                                                                      • pro
                                                                                                                      • business
                                                                                                                      • enterprise

                                                                                                                      Automatically minify certain assets for your website (https://support.cloudflare.com/hc/en-us/articles/200168196).

                                                                                                                      PATCH zones/:zone_identifier/settings/minify

                                                                                                                      Required parameters

                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                      value
                                                                                                                      object

                                                                                                                      Value of the zone setting

                                                                                                                      { "css": "off", "html": "off", "js": "off" }
                                                                                                                      An object with the following properties:
                                                                                                                        cURL (example)
                                                                                                                        curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/minify" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":{"css":"off","html":"off","js":"off"}}'
                                                                                                                        Response (example)
                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "minify",
    "value": {
      "css": "off",
      "html": "off",
      "js": "off"
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                        zone-settings-change-mobile-redirect-setting

                                                                                                                        PATCH Change Mobile Redirect setting permission needed: #zone_settings:edit
                                                                                                                        • free
                                                                                                                        • pro
                                                                                                                        • business
                                                                                                                        • enterprise

                                                                                                                        Automatically redirect visitors on mobile devices to a mobile-optimized subdomain (https://support.cloudflare.com/hc/en-us/articles/200168336).

                                                                                                                        PATCH zones/:zone_identifier/settings/mobile_redirect

                                                                                                                        Required parameters

                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                        value
                                                                                                                        object

                                                                                                                        Value of the zone setting

                                                                                                                        { "status": "off", "mobile_subdomain": "m", "strip_uri": false }
                                                                                                                        An object with the following properties:
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mobile_redirect" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":{"status":"off","mobile_subdomain":"m","strip_uri":false}}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "mobile_redirect",
    "value": {
      "status": "off",
      "mobile_subdomain": "m",
      "strip_uri": false
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-mirage-setting

                                                                                                                          PATCH Change Mirage setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Automatically optimize image loading for website visitors on mobile devices (http://blog.cloudflare.com/mirage2-solving-mobile-speed).

                                                                                                                          PATCH zones/:zone_identifier/settings/mirage

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: on, off
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/mirage" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "mirage",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-opportunistic-encryption-setting

                                                                                                                          PATCH Change Opportunistic Encryption setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Enable the Opportunistic Encryption feature for this zone.

                                                                                                                          PATCH zones/:zone_identifier/settings/opportunistic_encryption

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "on"
                                                                                                                          • default value: on
                                                                                                                          • valid values: on, off
                                                                                                                          • notes: Default value depends on the zone's plan level.
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/opportunistic_encryption" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "opportunistic_encryption",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-polish-setting

                                                                                                                          PATCH Change Polish setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Strips metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.

                                                                                                                          PATCH zones/:zone_identifier/settings/polish

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: off, lossless, lossy
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/polish" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "polish",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-webp-setting

                                                                                                                          PATCH Change WebP setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          When the client requesting the image supports the WebP image codec, Cloudflare will serve a WebP version of the image when WebP offers a performance advantage over the original image format.

                                                                                                                          PATCH zones/:zone_identifier/settings/webp

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: off, on
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/webp" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "webp",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-brotli-setting

                                                                                                                          PATCH Change Brotli setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          When the client requesting an asset supports the brotli compression algorithm, Cloudflare will serve a brotli compressed version of the asset.

                                                                                                                          PATCH zones/:zone_identifier/settings/brotli

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: off, on
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/brotli" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "brotli",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-prefetch-preload-setting

                                                                                                                          PATCH Change Prefetch Preload setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.

                                                                                                                          PATCH zones/:zone_identifier/settings/prefetch_preload

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: on, off
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/prefetch_preload" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                          zone-settings-change-privacy-pass-setting

                                                                                                                          PATCH Change Privacy Pass setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass)

                                                                                                                          PATCH zones/:zone_identifier/settings/privacy_pass

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "on"
                                                                                                                          • default value: on
                                                                                                                          • valid values: on, off
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/privacy_pass" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "privacy_pass",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-response-buffering-setting

                                                                                                                          PATCH Change Response Buffering setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.

                                                                                                                          PATCH zones/:zone_identifier/settings/response_buffering

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: on, off
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/response_buffering" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                          zone-settings-change-rocket-loader-setting

                                                                                                                          PATCH Change Rocket Loader setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Rocket Loader is a general-purpose asynchronous JavaScript optimisation which prioritises the rendering of your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP) and also the window.onload time (assuming there is JavaScript on the page), which can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. (https://support.cloudflare.com/hc/en-us/articles/200168056)

                                                                                                                          PATCH zones/:zone_identifier/settings/rocket_loader

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          string

                                                                                                                          Value of the zone setting

                                                                                                                          "off"
                                                                                                                          • default value: off
                                                                                                                          • valid values: on, off
                                                                                                                          cURL (example)
                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/rocket_loader" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                          Response (example)
                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "rocket_loader",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                          zone-settings-change-security-header-hsts-setting

                                                                                                                          PATCH Change Security Header (HSTS) setting permission needed: #zone_settings:edit
                                                                                                                          • free
                                                                                                                          • pro
                                                                                                                          • business
                                                                                                                          • enterprise

                                                                                                                          Cloudflare security header for a zone.

                                                                                                                          PATCH zones/:zone_identifier/settings/security_header

                                                                                                                          Required parameters

                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                          value
                                                                                                                          object
                                                                                                                          { "strict_transport_security": { "enabled": true, "max_age": 86400, "include_subdomains": true, "nosniff": true } }
                                                                                                                          An object with the following properties:
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_header" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":{"strict_transport_security":{"enabled":true,"max_age":86400,"include_subdomains":true,"nosniff":true}}}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "security_header",
    "value": {
      "strict_transport_security": {
        "enabled": true,
        "max_age": 86400,
        "include_subdomains": true,
        "nosniff": true
      }
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-security-level-setting

                                                                                                                            PATCH Change Security Level setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056)

                                                                                                                            PATCH zones/:zone_identifier/settings/security_level

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "medium"
                                                                                                                            • default value: medium
                                                                                                                            • valid values: off, essentially_off, low, medium, high, under_attack
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/security_level" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"medium"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "security_level",
    "value": "medium",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-server-side-exclude-setting

                                                                                                                            PATCH Change Server Side Exclude setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse--> Bad visitors won't see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036)

                                                                                                                            PATCH zones/:zone_identifier/settings/server_side_exclude

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "on"
                                                                                                                            • default value: on
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/server_side_exclude" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "server_side_exclude",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-ssl-setting

                                                                                                                            PATCH Change SSL setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416)

                                                                                                                            PATCH zones/:zone_identifier/settings/ssl

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: off, flexible, full, strict
                                                                                                                            • notes: Depends on the zone's plan level
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ssl",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-ssl/tls-recommender-enrollment

                                                                                                                            PATCH Change SSL/TLS Recommender enrollment permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.

                                                                                                                            PATCH zones/:zone_identifier/settings/ssl_recommender

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            enabled
                                                                                                                            boolean

                                                                                                                            ssl-recommender enrollment setting

                                                                                                                            false
                                                                                                                            • default value: false
                                                                                                                            • valid values: (true,false)
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ssl_recommender" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"enabled":false}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ssl_recommender",
    "enabled": false,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-tls-client-auth-setting

                                                                                                                            PATCH Change TLS Client Auth setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only)

                                                                                                                            PATCH zones/:zone_identifier/settings/tls_client_auth

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            value of the zone setting

                                                                                                                            "on"
                                                                                                                            • default value: on
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_client_auth" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"on"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "tls_client_auth",
    "value": "on",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-true-client-ip-setting

                                                                                                                            PATCH Change True Client IP setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.

                                                                                                                            PATCH zones/:zone_identifier/settings/true_client_ip_header

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/true_client_ip_header" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                            zone-settings-change-proxy-read-timeout-setting

                                                                                                                            PATCH Change Proxy Read Timeout setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Maximum time between two read operations from origin

                                                                                                                            PATCH zones/:zone_identifier/settings/proxy_read_timeout

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            number

                                                                                                                            Value of the zone setting

                                                                                                                            100
                                                                                                                            • default value: 100
                                                                                                                            • notes: Value must be between 1 and 6000
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/proxy_read_timeout" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":100}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "proxy_read_timeout",
    "value": 100,
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-minimum-tls-version-setting

                                                                                                                            PATCH Change Minimum TLS Version setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Only accept HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.

                                                                                                                            PATCH zones/:zone_identifier/settings/min_tls_version

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "1.0"
                                                                                                                            • default value: 1.0
                                                                                                                            • valid values: 1.0, 1.1, 1.2, 1.3
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/min_tls_version" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"1.0"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "1.0"
}
                                                                                                                            zone-settings-change-ciphers-setting

                                                                                                                            PATCH Change Ciphers setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.

                                                                                                                            PATCH zones/:zone_identifier/settings/ciphers

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            array

                                                                                                                            Value of the zone setting

                                                                                                                            [ "ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA" ]
                                                                                                                            An array with items in the following form:
                                                                                                                            • default value: List []
                                                                                                                            • unique items
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/ciphers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": []
}
                                                                                                                            zone-settings-change-tls-1.3-setting

                                                                                                                            PATCH Change TLS 1.3 setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Enable Crypto TLS 1.3 feature for this zone.

                                                                                                                            PATCH zones/:zone_identifier/settings/tls_1_3

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off, zrt
                                                                                                                            • notes: Default value depends on the zone's plan level.
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/tls_1_3" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "off"
}
                                                                                                                            zone-settings-change-web-application-firewall-waf-setting

                                                                                                                            PATCH Change Web Application Firewall (WAF) setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016)

                                                                                                                            PATCH zones/:zone_identifier/settings/waf

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/waf" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "waf",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-http2-setting

                                                                                                                            PATCH Change HTTP2 setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Value of the HTTP2 setting

                                                                                                                            PATCH zones/:zone_identifier/settings/http2

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the HTTP2 setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http2" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "http2",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-http3-setting

                                                                                                                            PATCH Change HTTP3 setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Value of the HTTP3 setting

                                                                                                                            PATCH zones/:zone_identifier/settings/http3

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the HTTP3 setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/http3" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "http3",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-0-rtt-session-resumption-setting

                                                                                                                            PATCH Change 0-RTT session resumption setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Value of the 0-RTT setting

                                                                                                                            PATCH zones/:zone_identifier/settings/0rtt

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the 0-RTT setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/0rtt" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0rtt",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-pseudo-ipv4-setting

                                                                                                                            PATCH Change Pseudo IPv4 setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Value of the Pseudo IPv4 setting

                                                                                                                            PATCH zones/:zone_identifier/settings/pseudo_ipv4

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the Pseudo IPv4 setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: off, add_header, overwrite_header
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/pseudo_ipv4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "pseudo_ipv4",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-websockets-setting

                                                                                                                            PATCH Change WebSockets setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. (https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-)

                                                                                                                            PATCH zones/:zone_identifier/settings/websockets

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: off, on
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/websockets" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "websockets",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-image-resizing-setting

                                                                                                                            PATCH Change Image Resizing setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. (https://developers.cloudflare.com/images/)

                                                                                                                            PATCH zones/:zone_identifier/settings/image_resizing

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Whether the feature is enabled, disabled, or enabled in 'open proxy' mode

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off, open
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/image_resizing" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "image_resizing",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-http/2-edge-prioritization-setting

                                                                                                                            PATCH Change HTTP/2 Edge Prioritization setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.

                                                                                                                            PATCH zones/:zone_identifier/settings/h2_prioritization

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            string

                                                                                                                            Value of the zone setting

                                                                                                                            "off"
                                                                                                                            • default value: off
                                                                                                                            • valid values: on, off, custom
                                                                                                                            cURL (example)
                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/h2_prioritization" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":"off"}'
                                                                                                                            Response (example)
                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "h2_prioritization",
    "value": "off",
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                            zone-settings-change-automatic-platform-optimization-for-wordpress-setting

                                                                                                                            PATCH Change Automatic Platform Optimization for WordPress setting permission needed: #zone_settings:edit
                                                                                                                            • free
                                                                                                                            • pro
                                                                                                                            • business
                                                                                                                            • enterprise

                                                                                                                            Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare's edge network and caches third party fonts.

                                                                                                                            PATCH zones/:zone_identifier/settings/automatic_platform_optimization

                                                                                                                            Required parameters

                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                            value
                                                                                                                            object

                                                                                                                            Automatic Platform Optimization for WordPress serves your WordPress site from Cloudflare's edge network and caches third party fonts.

                                                                                                                            { "enabled": true, "cf": true, "wordpress": true, "wp_plugin": true, "hostnames": [ "www.example.com", "example.com", "shop.example.com" ], "cache_by_device_type": false }
                                                                                                                            An object with the following properties:
                                                                                                                              cURL (example)
                                                                                                                              curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/settings/automatic_platform_optimization" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":{"enabled":true,"cf":true,"wordpress":true,"wp_plugin":true,"hostnames":["www.example.com","example.com","shop.example.com"],"cache_by_device_type":false}}'
                                                                                                                              Response (example)
                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "automatic_platform_optimization",
    "value": {
      "enabled": true,
      "cf": true,
      "wordpress": true,
      "wp_plugin": true,
      "hostnames": [
        "www.example.com",
        "example.com",
        "shop.example.com"
      ],
      "cache_by_device_type": false
    },
    "editable": true,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}

                                                                                                                              Zone Cache Settings

                                                                                                                              Zone level settings controlling how the Zone works in relation to the caching features of Cloudflare.

                                                                                                                              zone-cache-settings

                                                                                                                              Object definitions

                                                                                                                              View properties and constraints defined on the object

                                                                                                                              Show definitions

                                                                                                                              zone-cache-settings-get-variants-setting

                                                                                                                              GET Get Variants setting permission needed: #zone_settings:read
                                                                                                                              • free
                                                                                                                              • pro
                                                                                                                              • business
                                                                                                                              • enterprise

                                                                                                                              Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

                                                                                                                              GET zones/:zone_identifier/cache/variants
                                                                                                                              cURL (example)
                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/variants" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                              Response (example)
                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "variants",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "value": {
      "avif": [
        "image/webp",
        "image/jpeg"
      ],
      "bmp": [
        "image/webp",
        "image/jpeg"
      ],
      "gif": [
        "image/webp",
        "image/jpeg"
      ],
      "jpeg": [
        "image/webp",
        "image/avif"
      ],
      "jpg": [
        "image/webp",
        "image/avif"
      ],
      "jpg2": [
        "image/webp",
        "image/avif"
      ],
      "jp2": [
        "image/webp",
        "image/avif"
      ],
      "png": [
        "image/webp",
        "image/avif"
      ],
      "tiff": [
        "image/webp",
        "image/avif"
      ],
      "tif": [
        "image/webp",
        "image/avif"
      ],
      "webp": [
        "image/jpeg",
        "image/avif"
      ]
    }
  }
}
                                                                                                                              zone-cache-settings-change-variants-setting

                                                                                                                              PATCH Change Variants setting permission needed: #zone_settings:edit
                                                                                                                              • free
                                                                                                                              • pro
                                                                                                                              • business
                                                                                                                              • enterprise

                                                                                                                              Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

                                                                                                                              PATCH zones/:zone_identifier/cache/variants

                                                                                                                              Required parameters

                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                              value
                                                                                                                              object

                                                                                                                              Value of the zone setting

                                                                                                                              { "avif": [ "image/webp", "image/jpeg" ], "bmp": [ "image/webp", "image/jpeg" ], "gif": [ "image/webp", "image/jpeg" ], "jpeg": [ "image/webp", "image/avif" ], "jpg": [ "image/webp", "image/avif" ], "jpg2": [ "image/webp", "image/avif" ], "jp2": [ "image/webp", "image/avif" ], "png": [ "image/webp", "image/avif" ], "tiff": [ "image/webp", "image/avif" ], "tif": [ "image/webp", "image/avif" ], "webp": [ "image/jpeg", "image/avif" ] }
                                                                                                                              An object with the following properties:
                                                                                                                                cURL (example)
                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/variants" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"value":{"avif":["image/webp","image/jpeg"],"bmp":["image/webp","image/jpeg"],"gif":["image/webp","image/jpeg"],"jpeg":["image/webp","image/avif"],"jpg":["image/webp","image/avif"],"jpg2":["image/webp","image/avif"],"jp2":["image/webp","image/avif"],"png":["image/webp","image/avif"],"tiff":["image/webp","image/avif"],"tif":["image/webp","image/avif"],"webp":["image/jpeg","image/avif"]}}'
                                                                                                                                Response (example)
                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "variants",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "value": {
      "avif": [
        "image/webp",
        "image/jpeg"
      ],
      "bmp": [
        "image/webp",
        "image/jpeg"
      ],
      "gif": [
        "image/webp",
        "image/jpeg"
      ],
      "jpeg": [
        "image/webp",
        "image/avif"
      ],
      "jpg": [
        "image/webp",
        "image/avif"
      ],
      "jpg2": [
        "image/webp",
        "image/avif"
      ],
      "jp2": [
        "image/webp",
        "image/avif"
      ],
      "png": [
        "image/webp",
        "image/avif"
      ],
      "tiff": [
        "image/webp",
        "image/avif"
      ],
      "tif": [
        "image/webp",
        "image/avif"
      ],
      "webp": [
        "image/jpeg",
        "image/avif"
      ]
    }
  }
}
                                                                                                                                zone-cache-settings-delete-variants-setting

                                                                                                                                DELETE Delete Variants setting permission needed: #zone_settings:edit
                                                                                                                                • free
                                                                                                                                • pro
                                                                                                                                • business
                                                                                                                                • enterprise

                                                                                                                                Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

                                                                                                                                DELETE zones/:zone_identifier/cache/variants
                                                                                                                                cURL (example)
                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/cache/variants" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                Response (example)
                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "variants",
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}

                                                                                                                                Zone Cache Settings error codes

                                                                                                                                CodeDescription
                                                                                                                                1134Unable to parse zone setting value.
                                                                                                                                1135Sorry, this zone setting is not available for your plan type.
                                                                                                                                1136Sorry, you do not have access to this zone setting for that zone id or that zone id is invalid.
                                                                                                                                1137Unable to process request. Internal error.
                                                                                                                                1138Unable to retrieve <zone_cache_setting_id> setting value. Internal error.
                                                                                                                                1140Unable to update <zone_cache_setting_id> setting value. Internal error.
                                                                                                                                1141Unable to delete <zone_cache_setting_id> setting. Internal error.
                                                                                                                                1142Unable to retrieve <zone_cache_setting_id> setting value. The zone setting does not exist.
                                                                                                                                1144Unable to delete <zone_cache_setting_id> setting. The zone setting does not exist.
                                                                                                                                1146The value provided for <zone_cache_setting_id> setting is not valid.

                                                                                                                                Zone Analytics

                                                                                                                                Analytics data for a zone

                                                                                                                                zone-analytics

                                                                                                                                Object definitions

                                                                                                                                View properties and constraints defined on the object

                                                                                                                                Show definitions

                                                                                                                                Deprecation Warning

                                                                                                                                End of life Date: March 1, 2021

                                                                                                                                Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.

                                                                                                                                zone-analytics-dashboard

                                                                                                                                GET Dashboard permission needed: #analytics:read
                                                                                                                                • free
                                                                                                                                • pro
                                                                                                                                • business
                                                                                                                                • enterprise

                                                                                                                                The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.

                                                                                                                                GET zones/:zone_identifier/analytics/dashboard

                                                                                                                                Optional parameters

                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                since
                                                                                                                                stringinteger

                                                                                                                                The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.

                                                                                                                                Ranges that the Cloudflare web application provides will provide the following period length for each point:

                                                                                                                                • Last 60 minutes (from -59 to -1): 1 minute resolution
                                                                                                                                • Last 7 hours (from -419 to -60): 15 minutes resolution
                                                                                                                                • Last 15 hours (from -899 to -420): 30 minutes resolution
                                                                                                                                • Last 72 hours (from -4320 to -900): 1 hour resolution
                                                                                                                                • Older than 3 days (-525600 to -4320): 1 day resolution
                                                                                                                                "2015-01-01T12:23:00Z"
                                                                                                                                • default value: -10080
                                                                                                                                until
                                                                                                                                stringinteger

                                                                                                                                The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.

                                                                                                                                "2015-01-02T12:23:00Z"
                                                                                                                                • default value: 0
                                                                                                                                continuous
                                                                                                                                boolean

                                                                                                                                When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.

                                                                                                                                The API response may not represent the requested time window.

                                                                                                                                true
                                                                                                                                • default value: true
                                                                                                                                • valid values: (true,false)
                                                                                                                                cURL (example)
                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/dashboard?since=2015-01-01T12:23:00Z&until=2015-01-02T12:23:00Z&continuous=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                Response (example)
                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "totals": {
      "since": "2015-01-01T12:23:00Z",
      "until": "2015-01-02T12:23:00Z",
      "requests": {
        "all": 1234085328,
        "cached": 1234085328,
        "uncached": 13876154,
        "content_type": {
          "css": 15343,
          "html": 1234213,
          "javascript": 318236,
          "gif": 23178,
          "jpeg": 1982048
        },
        "country": {
          "US": 4181364,
          "AG": 37298,
          "GI": 293846
        },
        "ssl": {
          "encrypted": 12978361,
          "unencrypted": 781263
        },
        "ssl_protocols": {
          "TLSv1": 398232,
          "TLSv1.1": 12532236,
          "TLSv1.2": 2447136,
          "TLSv1.3": 10483332,
          "none": 781263
        },
        "http_status": {
          "200": 13496983,
          "301": 283,
          "400": 187936,
          "402": 1828,
          "404": 1293
        }
      },
      "bandwidth": {
        "all": 213867451,
        "cached": 113205063,
        "uncached": 113205063,
        "content_type": {
          "css": 237421,
          "html": 1231290,
          "javascript": 123245,
          "gif": 1234242,
          "jpeg": 784278
        },
        "country": {
          "US": 123145433,
          "AG": 2342483,
          "GI": 984753
        },
        "ssl": {
          "encrypted": 37592942,
          "unencrypted": 237654192
        },
        "ssl_protocols": {
          "TLSv1": 398232,
          "TLSv1.1": 12532236,
          "TLSv1.2": 2447136,
          "TLSv1.3": 10483332,
          "none": 781263
        }
      },
      "threats": {
        "all": 23423873,
        "country": {
          "US": 123,
          "CN": 523423,
          "AU": 91
        },
        "type": {
          "user.ban.ip": 123,
          "hot.ban.unknown": 5324,
          "macro.chl.captchaErr": 1341,
          "macro.chl.jschlErr": 5323
        }
      },
      "pageviews": {
        "all": 5724723,
        "search_engine": {
          "googlebot": 35272,
          "pingdom": 13435,
          "bingbot": 5372,
          "baidubot": 1345
        }
      },
      "uniques": {
        "all": 12343
      }
    },
    "timeseries": [
      {
        "since": "2015-01-01T12:23:00Z",
        "until": "2015-01-02T12:23:00Z",
        "requests": {
          "all": 1234085328,
          "cached": 1234085328,
          "uncached": 13876154,
          "content_type": {
            "css": 15343,
            "html": 1234213,
            "javascript": 318236,
            "gif": 23178,
            "jpeg": 1982048
          },
          "country": {
            "US": 4181364,
            "AG": 37298,
            "GI": 293846
          },
          "ssl": {
            "encrypted": 12978361,
            "unencrypted": 781263
          },
          "ssl_protocols": {
            "TLSv1": 398232,
            "TLSv1.1": 12532236,
            "TLSv1.2": 2447136,
            "TLSv1.3": 10483332,
            "none": 781263
          },
          "http_status": {
            "200": 13496983,
            "301": 283,
            "400": 187936,
            "402": 1828,
            "404": 1293
          }
        },
        "bandwidth": {
          "all": 213867451,
          "cached": 113205063,
          "uncached": 113205063,
          "content_type": {
            "css": 237421,
            "html": 1231290,
            "javascript": 123245,
            "gif": 1234242,
            "jpeg": 784278
          },
          "country": {
            "US": 123145433,
            "AG": 2342483,
            "GI": 984753
          },
          "ssl": {
            "encrypted": 37592942,
            "unencrypted": 237654192
          },
          "ssl_protocols": {
            "TLSv1": 398232,
            "TLSv1.1": 12532236,
            "TLSv1.2": 2447136,
            "TLSv1.3": 10483332,
            "none": 781263
          }
        },
        "threats": {
          "all": 23423873,
          "country": {
            "US": 123,
            "CN": 523423,
            "AU": 91
          },
          "type": {
            "user.ban.ip": 123,
            "hot.ban.unknown": 5324,
            "macro.chl.captchaErr": 1341,
            "macro.chl.jschlErr": 5323
          }
        },
        "pageviews": {
          "all": 5724723,
          "search_engine": {
            "googlebot": 35272,
            "pingdom": 13435,
            "bingbot": 5372,
            "baidubot": 1345
          }
        },
        "uniques": {
          "all": 12343
        }
      }
    ]
  },
  "query": {
    "since": "2015-01-01T12:23:00Z",
    "until": "2015-01-02T12:23:00Z",
    "time_delta": 60
  }
}

                                                                                                                                Deprecation Warning

                                                                                                                                End of life Date: March 1, 2021

                                                                                                                                Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.

                                                                                                                                zone-analytics-analytics-by-co-locations

                                                                                                                                GET Analytics by Co-locations permission needed: #analytics:read
                                                                                                                                • free
                                                                                                                                • pro
                                                                                                                                • business
                                                                                                                                • enterprise

                                                                                                                                This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.

                                                                                                                                GET zones/:zone_identifier/analytics/colos

                                                                                                                                Optional parameters

                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                since
                                                                                                                                stringinteger

                                                                                                                                The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.

                                                                                                                                Ranges that the Cloudflare web application provides will provide the following period length for each point:

                                                                                                                                • Last 60 minutes (from -59 to -1): 1 minute resolution
                                                                                                                                • Last 7 hours (from -419 to -60): 15 minutes resolution
                                                                                                                                • Last 15 hours (from -899 to -420): 30 minutes resolution
                                                                                                                                • Last 72 hours (from -4320 to -900): 1 hour resolution
                                                                                                                                • Older than 3 days (-525600 to -4320): 1 day resolution
                                                                                                                                "2015-01-01T12:23:00Z"
                                                                                                                                • default value: -10080
                                                                                                                                until
                                                                                                                                stringinteger

                                                                                                                                The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.

                                                                                                                                "2015-01-02T12:23:00Z"
                                                                                                                                • default value: 0
                                                                                                                                continuous
                                                                                                                                boolean

                                                                                                                                When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.

                                                                                                                                The API response may not represent the requested time window.

                                                                                                                                true
                                                                                                                                • default value: true
                                                                                                                                • valid values: (true,false)
                                                                                                                                cURL (example)
                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/analytics/colos?since=2015-01-01T12:23:00Z&until=2015-01-02T12:23:00Z&continuous=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                Response (example)
                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "colo_id": "SFO",
      "timeseries": [
        {
          "since": "2015-01-01T12:23:00Z",
          "until": "2015-01-02T12:23:00Z",
          "requests": {
            "all": 1234085328,
            "cached": 1234085328,
            "uncached": 13876154,
            "country": {
              "US": 4181364,
              "AG": 37298,
              "GI": 293846
            },
            "http_status": {
              "200": 13496983,
              "301": 283,
              "400": 187936,
              "402": 1828,
              "404": 1293
            }
          },
          "bandwidth": {
            "all": 213867451,
            "cached": 113205063,
            "uncached": 113205063
          },
          "threats": {
            "all": 23423873,
            "country": {
              "US": 123,
              "CN": 523423,
              "AU": 91
            },
            "type": {
              "user.ban.ip": 123,
              "hot.ban.unknown": 5324,
              "macro.chl.captchaErr": 1341,
              "macro.chl.jschlErr": 5323
            }
          }
        }
      ],
      "totals": {
        "since": "2015-01-01T12:23:00Z",
        "until": "2015-01-02T12:23:00Z",
        "requests": {
          "all": 1234085328,
          "cached": 1234085328,
          "uncached": 13876154,
          "country": {
            "US": 4181364,
            "AG": 37298,
            "GI": 293846
          },
          "http_status": {
            "200": 13496983,
            "301": 283,
            "400": 187936,
            "402": 1828,
            "404": 1293
          }
        },
        "bandwidth": {
          "all": 213867451,
          "cached": 113205063,
          "uncached": 113205063
        },
        "threats": {
          "all": 23423873,
          "country": {
            "US": 123,
            "CN": 523423,
            "AU": 91
          },
          "type": {
            "user.ban.ip": 123,
            "hot.ban.unknown": 5324,
            "macro.chl.captchaErr": 1341,
            "macro.chl.jschlErr": 5323
          }
        }
      }
    }
  ],
  "query": {
    "since": "2015-01-01T12:23:00Z",
    "until": "2015-01-02T12:23:00Z",
    "time_delta": 60
  }
}

                                                                                                                                Logs Received

                                                                                                                                Edge http logs received

                                                                                                                                logs-received

                                                                                                                                Object definitions

                                                                                                                                View properties and constraints defined on the object

                                                                                                                                Show definitions

                                                                                                                                logs-received-get-log-retention-flag

                                                                                                                                GET Get log retention flag permission needed: #logs:edit
                                                                                                                                • free
                                                                                                                                • pro
                                                                                                                                • business
                                                                                                                                • enterprise

                                                                                                                                Get log retention flag for Logpull API

                                                                                                                                GET zones/:zone_identifier/logs/control/retention/flag
                                                                                                                                cURL (example)
                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/control/retention/flag" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                Response (example)
                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "flag": true
  }
}
                                                                                                                                logs-received-update-log-retention-flag

                                                                                                                                POST Update log retention flag permission needed: #logs:edit
                                                                                                                                • free
                                                                                                                                • pro
                                                                                                                                • business
                                                                                                                                • enterprise

                                                                                                                                Update log retention flag for Logpull API

                                                                                                                                POST zones/:zone_identifier/logs/control/retention/flag

                                                                                                                                Required parameters

                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                flag
                                                                                                                                boolean

                                                                                                                                The log retention flag for Logpull API.

                                                                                                                                true
                                                                                                                                • valid values: (true,false)
                                                                                                                                cURL (example)
                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/control/retention/flag" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"flag":true}'
                                                                                                                                Response (example)
                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "flag": true
  }
}
                                                                                                                                logs-received-logs-received

                                                                                                                                GET Logs Received permission needed: #logs:read
                                                                                                                                • free
                                                                                                                                • pro
                                                                                                                                • business
                                                                                                                                • enterprise

                                                                                                                                The /received api route allows customers to retrieve their edge http logs. The basic access pattern is "give me all the logs for zone Z for minute M" where the minute M refers to the time records were received at Cloudflare's central data center. start is inclusive, and end is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z, then start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z and so on; the "overlap" will be handled properly.

                                                                                                                                GET zones/:zone_identifier/logs/received

                                                                                                                                Required parameters

                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                start
                                                                                                                                stringinteger

                                                                                                                                The (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than 7 days.

                                                                                                                                "2018-05-20T10:00:00Z"
                                                                                                                                  end
                                                                                                                                  stringinteger

                                                                                                                                  The (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. end must be at least 5 minutes earlier than now and must be later than start. Difference between start and end must be not greater than 1h.

                                                                                                                                  "2018-05-20T10:01:00Z"

                                                                                                                                    Optional parameters

                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                    count
                                                                                                                                    integer

                                                                                                                                    When ?count= is provided, the response will contain up to count results. Since results are not sorted, you are likely to get different data for repeated requests. count must be an integer > 0.

                                                                                                                                    7
                                                                                                                                    • min value:1
                                                                                                                                    sample
                                                                                                                                    number

                                                                                                                                    When ?sample= is provided, a sample of matching records is returned. If sample=0.1 then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When ?count= is also specified, count is applied to the number of returned records, not the sampled records. So, with sample=0.05 and count=7, when there is a total of 100 records available, approximately 5 will be returned. When there are 1000 records, 7 will be returned. When there are 10,000 records, 7 will be returned.

                                                                                                                                    "0.1"
                                                                                                                                    • min value:0
                                                                                                                                    • max value:1
                                                                                                                                    fields
                                                                                                                                    string

                                                                                                                                    The /received route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. most customers require only a small subset of fields, but that subset varies from customer to customer; 2. flat schema is much easier to work with downstream (importing into BigTable etc); 3. performance (time to process, file size). If ?fields= is not specified, default field set is returned. This default field set may change at any time. When ?fields= is provided, each record is returned with the specified fields. fields must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified doesn't matter, and the order of fields in the response is not specified.

                                                                                                                                    "ClientIP,RayID,EdgeStartTimestamp"
                                                                                                                                      timestamps
                                                                                                                                      string

                                                                                                                                      By default timestamps in responses are returned as Unix nanosecond integers. The ?timestamps= argument can be set to change the format in which response timestamps are returned. Possible values are: unix, unixnano, rfc3339. Note: unix and unixnano return timestamps as integers; rfc3339 returns timestamps as strings.

                                                                                                                                      "unixnano"
                                                                                                                                      • default value: unixnano
                                                                                                                                      • valid values: unix, unixnano, rfc3339
                                                                                                                                      cURL (example)
                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/received?start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z&count=7&sample=0.1&fields=ClientIP,RayID,EdgeStartTimestamp&timestamps=unixnano" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                      Response (example)
                                                                                                                                      {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}
                                                                                                                                      logs-received-logs-rayids

                                                                                                                                      GET Logs RayIDs permission needed: #logs:read
                                                                                                                                      • free
                                                                                                                                      • pro
                                                                                                                                      • business
                                                                                                                                      • enterprise

                                                                                                                                      The /rayids api route allows lookups by specific rayid. The rayids route will return 0, 1, or more records (ray ids are not unique).

                                                                                                                                      GET zones/:zone_identifier/logs/rayids/:ray_identifier

                                                                                                                                      Optional parameters

                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                      fields
                                                                                                                                      string

                                                                                                                                      The /received route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. most customers require only a small subset of fields, but that subset varies from customer to customer; 2. flat schema is much easier to work with downstream (importing into BigTable etc); 3. performance (time to process, file size). If ?fields= is not specified, default field set is returned. This default field set may change at any time. When ?fields= is provided, each record is returned with the specified fields. fields must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified doesn't matter, and the order of fields in the response is not specified.

                                                                                                                                      "ClientIP,RayID,EdgeStartTimestamp"
                                                                                                                                        timestamps
                                                                                                                                        string

                                                                                                                                        By default timestamps in responses are returned as Unix nanosecond integers. The ?timestamps= argument can be set to change the format in which response timestamps are returned. Possible values are: unix, unixnano, rfc3339. Note: unix and unixnano return timestamps as integers; rfc3339 returns timestamps as strings.

                                                                                                                                        "unixnano"
                                                                                                                                        • default value: unixnano
                                                                                                                                        • valid values: unix, unixnano, rfc3339
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/rayids/41ddf1740f67442d?fields=ClientIP,RayID,EdgeStartTimestamp&timestamps=unixnano" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}
{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}
                                                                                                                                        logs-received-fields

                                                                                                                                        GET Fields permission needed: #logs:read
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        The list of all fields available. The response is json object with key-value pairs where keys are field names, and values are descriptions.

                                                                                                                                        GET zones/:zone_identifier/logs/received/fields
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logs/received/fields" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {
  "key": "value"
}

                                                                                                                                        Logs Received Notes

                                                                                                                                        If there is an error processing the request before any data has been sent to the client, appropriate status code will be set and error message will be sent in the response body. If there is an error after the response started then an error message will be appended to the response body and the response will be aborted (connection will be closed).

                                                                                                                                        Logpush Jobs

                                                                                                                                        Logpush jobs

                                                                                                                                        logpush-jobs

                                                                                                                                        Object definition

                                                                                                                                        View properties and constraints defined on the object

                                                                                                                                        Show definition

                                                                                                                                        logpush-jobs-list-logpush-jobs

                                                                                                                                        GET List Logpush Jobs permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        List Logpush Jobs for a zone

                                                                                                                                        GET zones/:zone_identifier/logpush/jobs
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "enabled": false,
      "name": "example.com",
      "dataset": "http_requests",
      "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339",
      "destination_conf": "s3://mybucket/logs?region=us-west-2",
      "last_complete": null,
      "last_error": null,
      "error_message": null,
      "frequency": "high"
    }
  ]
}
                                                                                                                                        logpush-jobs-list-logpush-jobs-for-a-dataset

                                                                                                                                        GET List Logpush Jobs for a dataset permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        List Logpush Jobs for a zone for a dataset

                                                                                                                                        GET zones/:zone_identifier/logpush/datasets/:dataset/jobs
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/datasets/http_requests/jobs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "enabled": false,
      "name": "example.com",
      "dataset": "http_requests",
      "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339",
      "destination_conf": "s3://mybucket/logs?region=us-west-2",
      "last_complete": null,
      "last_error": null,
      "error_message": null,
      "frequency": "high"
    }
  ]
}
                                                                                                                                        logpush-jobs-fields

                                                                                                                                        GET Fields permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        The list of all fields available for a dataset. The response result is an object with key-value pairs where keys are field names, and values are descriptions.

                                                                                                                                        GET zones/:zone_identifier/logpush/datasets/:dataset/fields
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/datasets/http_requests/fields" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                        logpush-jobs-get-ownership-challenge

                                                                                                                                        POST Get Ownership Challenge permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Get a new ownership challenge sent to your destination

                                                                                                                                        POST zones/:zone_identifier/logpush/ownership

                                                                                                                                        Required parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        destination_conf
                                                                                                                                        string (uri)

                                                                                                                                        Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

                                                                                                                                        "s3://mybucket/logs?region=us-west-2"
                                                                                                                                        • max length: 4096
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/ownership" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"destination_conf":"s3://mybucket/logs?region=us-west-2"}'
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "filename": "logs/challenge-filename.txt",
    "valid": true,
    "message": ""
  }
}
                                                                                                                                        logpush-jobs-validate-ownership-challenge

                                                                                                                                        POST Validate Ownership Challenge permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Validate ownership challenge of the destination

                                                                                                                                        POST zones/:zone_identifier/logpush/ownership/validate

                                                                                                                                        Required parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        destination_conf
                                                                                                                                        string (uri)

                                                                                                                                        Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

                                                                                                                                        "s3://mybucket/logs?region=us-west-2"
                                                                                                                                        • max length: 4096
                                                                                                                                        ownership_challenge
                                                                                                                                        string

                                                                                                                                        Ownership challenge token to prove destination ownership.

                                                                                                                                        "00000000000000000000"
                                                                                                                                        • max length: 4096
                                                                                                                                        • pattern: ^[a-zA-Z0-9/\+\.\-_]*$
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/ownership/validate" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"destination_conf":"s3://mybucket/logs?region=us-west-2","ownership_challenge":"00000000000000000000"}'
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "valid": true
  }
}
                                                                                                                                        logpush-jobs-validate-origin

                                                                                                                                        POST Validate Origin permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Validate logpull origin with logpull_options

                                                                                                                                        POST zones/:zone_identifier/logpush/validate/origin

                                                                                                                                        Required parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        logpull_options
                                                                                                                                        stringnull (uri)

                                                                                                                                        Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

                                                                                                                                        "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339"
                                                                                                                                        • max length: 4096
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/validate/origin" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"logpull_options":"fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339"}'
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "valid": true,
    "message": ""
  }
}
                                                                                                                                        logpush-jobs-create-logpush-job

                                                                                                                                        POST Create Logpush Job permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Create a new Logpush Job for a zone

                                                                                                                                        POST zones/:zone_identifier/logpush/jobs

                                                                                                                                        Required parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        destination_conf
                                                                                                                                        string (uri)

                                                                                                                                        Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

                                                                                                                                        "s3://mybucket/logs?region=us-west-2"
                                                                                                                                        • max length: 4096

                                                                                                                                        Optional parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        name
                                                                                                                                        stringnull

                                                                                                                                        Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.

                                                                                                                                        "example.com"
                                                                                                                                        • max length: 512
                                                                                                                                        • pattern: ^[a-zA-Z0-9\-\.]*$
                                                                                                                                        enabled
                                                                                                                                        boolean
                                                                                                                                        false
                                                                                                                                        • valid values: (true,false)
                                                                                                                                        dataset
                                                                                                                                        stringnull

                                                                                                                                        Dataset to be pulled.

                                                                                                                                        "http_requests"
                                                                                                                                        • max length: 256
                                                                                                                                        • pattern: ^[a-zA-Z0-9_\-]*$
                                                                                                                                        logpull_options
                                                                                                                                        stringnull (uri)

                                                                                                                                        Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

                                                                                                                                        "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339"
                                                                                                                                        • max length: 4096
                                                                                                                                        ownership_challenge
                                                                                                                                        string

                                                                                                                                        Ownership challenge token to prove destination ownership.

                                                                                                                                        "00000000000000000000"
                                                                                                                                        • max length: 4096
                                                                                                                                        • pattern: ^[a-zA-Z0-9/\+\.\-_]*$
                                                                                                                                        frequency
                                                                                                                                        stringnull

                                                                                                                                        The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

                                                                                                                                        "high"
                                                                                                                                        • default value: high
                                                                                                                                        • valid values: high, low
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"example.com","enabled":false,"dataset":"http_requests","logpull_options":"fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339","destination_conf":"s3://mybucket/logs?region=us-west-2","ownership_challenge":"00000000000000000000","frequency":"high"}'
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 1,
    "enabled": false,
    "name": "example.com",
    "dataset": "http_requests",
    "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339",
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "last_complete": null,
    "last_error": null,
    "error_message": null,
    "frequency": "high"
  }
}
                                                                                                                                        logpush-jobs-logpush-job-details

                                                                                                                                        GET Logpush Job Details permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Get the details of a Logpush Job

                                                                                                                                        GET zones/:zone_identifier/logpush/jobs/:job_identifier
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 1,
    "enabled": false,
    "name": "example.com",
    "dataset": "http_requests",
    "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339",
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "last_complete": null,
    "last_error": null,
    "error_message": null,
    "frequency": "high"
  }
}
                                                                                                                                        logpush-jobs-update-logpush-job

                                                                                                                                        PUT Update Logpush Job permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Update a Logpush Job

                                                                                                                                        PUT zones/:zone_identifier/logpush/jobs/:job_identifier

                                                                                                                                        Optional parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        enabled
                                                                                                                                        boolean
                                                                                                                                        false
                                                                                                                                        • valid values: (true,false)
                                                                                                                                        logpull_options
                                                                                                                                        stringnull (uri)

                                                                                                                                        Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

                                                                                                                                        "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339"
                                                                                                                                        • max length: 4096
                                                                                                                                        destination_conf
                                                                                                                                        string (uri)

                                                                                                                                        Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

                                                                                                                                        "s3://mybucket/logs?region=us-west-2"
                                                                                                                                        • max length: 4096
                                                                                                                                        ownership_challenge
                                                                                                                                        string

                                                                                                                                        Ownership challenge token to prove destination ownership.

                                                                                                                                        "00000000000000000000"
                                                                                                                                        • max length: 4096
                                                                                                                                        • pattern: ^[a-zA-Z0-9/\+\.\-_]*$
                                                                                                                                        frequency
                                                                                                                                        stringnull

                                                                                                                                        The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

                                                                                                                                        "high"
                                                                                                                                        • default value: high
                                                                                                                                        • valid values: high, low
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"enabled":false,"logpull_options":"fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339","destination_conf":"s3://mybucket/logs?region=us-west-2","ownership_challenge":"00000000000000000000","frequency":"high"}'
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 1,
    "enabled": false,
    "name": "example.com",
    "dataset": "http_requests",
    "logpull_options": "fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339",
    "destination_conf": "s3://mybucket/logs?region=us-west-2",
    "last_complete": null,
    "last_error": null,
    "error_message": null,
    "frequency": "high"
  }
}
                                                                                                                                        logpush-jobs-delete-logpush-job

                                                                                                                                        DELETE Delete Logpush Job permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Delete a Logpush Job

                                                                                                                                        DELETE zones/:zone_identifier/logpush/jobs/:job_identifier
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/jobs/1" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {}
}
                                                                                                                                        logpush-jobs-check-destination-exists

                                                                                                                                        POST Check Destination Exists permission needed: #logs:edit
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        Check if there is an existing job with a destination

                                                                                                                                        POST zones/:zone_identifier/logpush/validate/destination/exists

                                                                                                                                        Required parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        destination_conf
                                                                                                                                        string (uri)

                                                                                                                                        Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

                                                                                                                                        "s3://mybucket/logs?region=us-west-2"
                                                                                                                                        • max length: 4096
                                                                                                                                        cURL (example)
                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/logpush/validate/destination/exists" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"destination_conf":"s3://mybucket/logs?region=us-west-2"}'
                                                                                                                                        Response (example)
                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "exists": false
  }
}

                                                                                                                                        Logpush Jobs error codes

                                                                                                                                        CodeDescription
                                                                                                                                        1000Not Found
                                                                                                                                        1001Internal Server Error
                                                                                                                                        1002Bad Request
                                                                                                                                        1003Request Entity Too Large
                                                                                                                                        1004Forbidden

                                                                                                                                        DNS Records for a Zone

                                                                                                                                        Documentation for Cloudflare DNS records

                                                                                                                                        dns-records-for-a-zone

                                                                                                                                        Object definitions

                                                                                                                                        View properties and constraints defined on the object

                                                                                                                                        Show definitions

                                                                                                                                        dns-records-for-a-zone-list-dns-records

                                                                                                                                        GET List DNS Records permission needed: #dns_records:read
                                                                                                                                        • free
                                                                                                                                        • pro
                                                                                                                                        • business
                                                                                                                                        • enterprise

                                                                                                                                        List, search, sort, and filter a zones' DNS records.

                                                                                                                                        GET zones/:zone_identifier/dns_records

                                                                                                                                        Optional parameters

                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                        match
                                                                                                                                        string

                                                                                                                                        Whether to match all search requirements or at least one (any)

                                                                                                                                        "all"
                                                                                                                                        • default value: all
                                                                                                                                        • valid values: any, all
                                                                                                                                        name
                                                                                                                                        string

                                                                                                                                        DNS record name

                                                                                                                                        "example.com"
                                                                                                                                        • max length: 255
                                                                                                                                        order
                                                                                                                                        string

                                                                                                                                        Field to order records by

                                                                                                                                        "type"
                                                                                                                                        • valid values: type, name, content, ttl, proxied
                                                                                                                                        page
                                                                                                                                        number

                                                                                                                                        Page number of paginated results

                                                                                                                                        1
                                                                                                                                        • default value: 1
                                                                                                                                        • min value:1
                                                                                                                                        per_page
                                                                                                                                        number

                                                                                                                                        Number of DNS records per page

                                                                                                                                        20
                                                                                                                                        • default value: 20
                                                                                                                                        • min value:5
                                                                                                                                        • max value:100
                                                                                                                                        content
                                                                                                                                        string

                                                                                                                                        DNS record content

                                                                                                                                        "127.0.0.1"
                                                                                                                                          type
                                                                                                                                          string

                                                                                                                                          DNS record type

                                                                                                                                          "A"
                                                                                                                                          • valid values: A, AAAA, CNAME, HTTPS, TXT, SRV, LOC, MX, NS, CERT, DNSKEY, DS, NAPTR, SMIMEA, SSHFP, SVCB, TLSA, URI
                                                                                                                                          • read only
                                                                                                                                          proxied
                                                                                                                                          boolean

                                                                                                                                          DNS record proxied status

                                                                                                                                          • valid values: (true,false)
                                                                                                                                          direction
                                                                                                                                          string

                                                                                                                                          Direction to order domains

                                                                                                                                          "desc"
                                                                                                                                          • valid values: asc, desc
                                                                                                                                          cURL (example)
                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records?type=A&name=example.com&content=127.0.0.1&proxied=undefined&page=1&per_page=20&order=type&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                          Response (example)
                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b59",
      "type": "A",
      "name": "example.com",
      "content": "198.51.100.4",
      "proxiable": true,
      "proxied": false,
      "ttl": 3600,
      "locked": false,
      "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "zone_name": "example.com",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "data": {},
      "meta": {
        "auto_added": true,
        "source": "primary"
      }
    }
  ]
}
                                                                                                                                          dns-records-for-a-zone-create-dns-record

                                                                                                                                          POST Create DNS Record permission needed: #dns_records:edit
                                                                                                                                          • free
                                                                                                                                          • pro
                                                                                                                                          • business
                                                                                                                                          • enterprise

                                                                                                                                          Create a new DNS record for a zone. See the record object definitions for required attributes for each record type

                                                                                                                                          POST zones/:zone_identifier/dns_records

                                                                                                                                          Required parameters

                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                          type
                                                                                                                                          string

                                                                                                                                          DNS record type

                                                                                                                                          "A"
                                                                                                                                          • valid values: A, AAAA, CNAME, HTTPS, TXT, SRV, LOC, MX, NS, CERT, DNSKEY, DS, NAPTR, SMIMEA, SSHFP, SVCB, TLSA, URI
                                                                                                                                          • read only
                                                                                                                                          name
                                                                                                                                          string

                                                                                                                                          DNS record name

                                                                                                                                          "example.com"
                                                                                                                                          • max length: 255
                                                                                                                                          content
                                                                                                                                          string

                                                                                                                                          DNS record content

                                                                                                                                          "127.0.0.1"
                                                                                                                                            ttl
                                                                                                                                            number

                                                                                                                                            Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'

                                                                                                                                            3600
                                                                                                                                            Any of the following:

                                                                                                                                              Optional parameters

                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                              priority
                                                                                                                                              number

                                                                                                                                              Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred

                                                                                                                                              10
                                                                                                                                              • min value:0
                                                                                                                                              • max value:65535
                                                                                                                                              proxied
                                                                                                                                              boolean

                                                                                                                                              Whether the record is receiving the performance and security benefits of Cloudflare

                                                                                                                                              false
                                                                                                                                              • valid values: (true,false)
                                                                                                                                              cURL (example)
                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":3600,"priority":10,"proxied":false}'
                                                                                                                                              Response (example)
                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "type": "A",
    "name": "example.com",
    "content": "198.51.100.4",
    "proxiable": true,
    "proxied": false,
    "ttl": 3600,
    "locked": false,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_name": "example.com",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "data": {},
    "meta": {
      "auto_added": true,
      "source": "primary"
    }
  }
}
                                                                                                                                              dns-records-for-a-zone-dns-record-details

                                                                                                                                              GET DNS Record Details permission needed: #dns_records:read
                                                                                                                                              • free
                                                                                                                                              • pro
                                                                                                                                              • business
                                                                                                                                              • enterprise

                                                                                                                                              GET zones/:zone_identifier/dns_records/:identifier
                                                                                                                                              cURL (example)
                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                              Response (example)
                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "type": "A",
    "name": "example.com",
    "content": "198.51.100.4",
    "proxiable": true,
    "proxied": false,
    "ttl": 3600,
    "locked": false,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_name": "example.com",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "data": {},
    "meta": {
      "auto_added": true,
      "source": "primary"
    }
  }
}
                                                                                                                                              dns-records-for-a-zone-update-dns-record

                                                                                                                                              PUT Update DNS Record permission needed: #dns_records:edit
                                                                                                                                              • free
                                                                                                                                              • pro
                                                                                                                                              • business
                                                                                                                                              • enterprise

                                                                                                                                              PUT zones/:zone_identifier/dns_records/:identifier

                                                                                                                                              Required parameters

                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                              type
                                                                                                                                              string

                                                                                                                                              DNS record type

                                                                                                                                              "A"
                                                                                                                                              • valid values: A, AAAA, CNAME, HTTPS, TXT, SRV, LOC, MX, NS, CERT, DNSKEY, DS, NAPTR, SMIMEA, SSHFP, SVCB, TLSA, URI
                                                                                                                                              • read only
                                                                                                                                              name
                                                                                                                                              string

                                                                                                                                              DNS record name

                                                                                                                                              "example.com"
                                                                                                                                              • max length: 255
                                                                                                                                              content
                                                                                                                                              string

                                                                                                                                              DNS record content

                                                                                                                                              "127.0.0.1"
                                                                                                                                                ttl
                                                                                                                                                number

                                                                                                                                                Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'

                                                                                                                                                3600
                                                                                                                                                Any of the following:

                                                                                                                                                  Optional parameters

                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                  proxied
                                                                                                                                                  boolean

                                                                                                                                                  Whether the record is receiving the performance and security benefits of Cloudflare

                                                                                                                                                  false
                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                  cURL (example)
                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":3600,"proxied":false}'
                                                                                                                                                  Response (example)
                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "type": "A",
    "name": "example.com",
    "content": "198.51.100.4",
    "proxiable": true,
    "proxied": false,
    "ttl": 3600,
    "locked": false,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_name": "example.com",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "data": {},
    "meta": {
      "auto_added": true,
      "source": "primary"
    }
  }
}
                                                                                                                                                  dns-records-for-a-zone-patch-dns-record

                                                                                                                                                  PATCH Patch DNS Record permission needed: #dns_records:edit
                                                                                                                                                  • free
                                                                                                                                                  • pro
                                                                                                                                                  • business
                                                                                                                                                  • enterprise

                                                                                                                                                  PATCH zones/:zone_identifier/dns_records/:identifier

                                                                                                                                                  Optional parameters

                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                  type
                                                                                                                                                  string

                                                                                                                                                  DNS record type

                                                                                                                                                  "A"
                                                                                                                                                  • valid values: A, AAAA, CNAME, HTTPS, TXT, SRV, LOC, MX, NS, CERT, DNSKEY, DS, NAPTR, SMIMEA, SSHFP, SVCB, TLSA, URI
                                                                                                                                                  • read only
                                                                                                                                                  name
                                                                                                                                                  string

                                                                                                                                                  DNS record name

                                                                                                                                                  "example.com"
                                                                                                                                                  • max length: 255
                                                                                                                                                  content
                                                                                                                                                  string

                                                                                                                                                  DNS record content

                                                                                                                                                  "127.0.0.1"
                                                                                                                                                    ttl
                                                                                                                                                    number

                                                                                                                                                    Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'

                                                                                                                                                    3600
                                                                                                                                                    Any of the following:
                                                                                                                                                      proxied
                                                                                                                                                      boolean

                                                                                                                                                      Whether the record is receiving the performance and security benefits of Cloudflare

                                                                                                                                                      false
                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                      cURL (example)
                                                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"A","name":"example.com","content":"127.0.0.1","ttl":3600,"proxied":false}'
                                                                                                                                                      Response (example)
                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "type": "A",
    "name": "example.com",
    "content": "198.51.100.4",
    "proxiable": true,
    "proxied": false,
    "ttl": 3600,
    "locked": false,
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "zone_name": "example.com",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "data": {},
    "meta": {
      "auto_added": true,
      "source": "primary"
    }
  }
}
                                                                                                                                                      dns-records-for-a-zone-delete-dns-record

                                                                                                                                                      DELETE Delete DNS Record permission needed: #dns_records:edit
                                                                                                                                                      • free
                                                                                                                                                      • pro
                                                                                                                                                      • business
                                                                                                                                                      • enterprise

                                                                                                                                                      DELETE zones/:zone_identifier/dns_records/:identifier
                                                                                                                                                      cURL (example)
                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                      Response (example)
                                                                                                                                                      {
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}
                                                                                                                                                      dns-records-for-a-zone-import-dns-records

                                                                                                                                                      POST Import DNS Records permission needed: #dns_records:edit
                                                                                                                                                      • free
                                                                                                                                                      • pro
                                                                                                                                                      • business
                                                                                                                                                      • enterprise

                                                                                                                                                      You can upload your BIND config through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.

                                                                                                                                                      POST zones/:zone_identifier/dns_records/import

                                                                                                                                                      Required parameters

                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                      file
                                                                                                                                                      string

                                                                                                                                                      BIND config to upload

                                                                                                                                                      "@bind_config.txt"

                                                                                                                                                        Optional parameters

                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                        proxied
                                                                                                                                                        boolean

                                                                                                                                                        Whether or not proxiable records should receive the performance and security benefits of Cloudflare

                                                                                                                                                        false
                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                        cURL (example)
                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/import" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     --form 'file=@bind_config.txt' \
     --form 'proxied=false'
                                                                                                                                                        Response (example)
                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "recs_added": 5,
    "total_records_parsed": 5
  },
  "timing": {
    "start_time": "2014-03-01T12:20:00Z",
    "end_time": "2014-03-01T12:20:01Z",
    "process_time": 1
  }
}
                                                                                                                                                        dns-records-for-a-zone-export-dns-records

                                                                                                                                                        GET Export DNS Records permission needed: #dns_records:read
                                                                                                                                                        • free
                                                                                                                                                        • pro
                                                                                                                                                        • business
                                                                                                                                                        • enterprise

                                                                                                                                                        You can export your BIND config through this endpoint.

                                                                                                                                                        GET zones/:zone_identifier/dns_records/export
                                                                                                                                                        cURL (example)
                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/export" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                        Response (example)
                                                                                                                                                        {}

                                                                                                                                                        DNS Records for a Zone error codes

                                                                                                                                                        CodeDescription
                                                                                                                                                        1000Invalid user
                                                                                                                                                        1002Invalid or missing zone_id
                                                                                                                                                        1003per_page must be a positive integer
                                                                                                                                                        1004Invalid or missing zone
                                                                                                                                                        1005Invalid or missing record
                                                                                                                                                        1007name required
                                                                                                                                                        1008content required
                                                                                                                                                        1009Invalid or missing record id
                                                                                                                                                        1010Invalid or missing record
                                                                                                                                                        1011Zone file for '<domain name>' could not be found
                                                                                                                                                        1012Zone file for '<domain name>' is not modifiable
                                                                                                                                                        1013The record could not be found
                                                                                                                                                        1014You do not have permission to modify this zone
                                                                                                                                                        1015Unknown error
                                                                                                                                                        1017Content for A record is invalid. Must be a valid IPv4 address
                                                                                                                                                        1018Content for AAAA record is invalid. Must be a valid IPv6 address
                                                                                                                                                        1019Content for CNAME record is invalid
                                                                                                                                                        1024Invalid priority, priority must be set and be between 0 and 65535
                                                                                                                                                        1025Invalid content for an MX record
                                                                                                                                                        1027Invalid service value
                                                                                                                                                        1028Invalid service value. Must be less than 100 characters
                                                                                                                                                        1029Invalid protocol value
                                                                                                                                                        1030Invalid protocol value. Must be less than 12 characters
                                                                                                                                                        1031Invalid SRV name
                                                                                                                                                        1032Invalid SRV name. Must be less than 90 characters
                                                                                                                                                        1033Invalid weight value. Must be between 0 and 65,535
                                                                                                                                                        1034Invalid port value. Must be between 0 and 65,535
                                                                                                                                                        1037Invalid domain name for a SRV target host
                                                                                                                                                        1038Invalid DNS record type
                                                                                                                                                        1039Invalid TTL. Must be between 60 and 86400 seconds, or 1 for automatic
                                                                                                                                                        1041Priority must be set for SRV record
                                                                                                                                                        1042Zone file for '<domain name>' could not be found
                                                                                                                                                        1043Zone file for '<domain name>' is not editable
                                                                                                                                                        1044A record with these exact values already exists. Please modify or remove this record
                                                                                                                                                        1045The record could not be found
                                                                                                                                                        1046A record with these exact values already exists. Please modify or cancel this edit
                                                                                                                                                        1047You do not have permission to modify this zone
                                                                                                                                                        1048You have reached the record limit for this zone
                                                                                                                                                        1049The record content is missing
                                                                                                                                                        1050Could not find record
                                                                                                                                                        1052You can not point a CNAME to itself
                                                                                                                                                        1053Invalid lat_degrees, must be an integer between 0 and 90 inclusive
                                                                                                                                                        1054Invalid lat_minutes, must be an integer between 0 and 59 inclusive
                                                                                                                                                        1055Invalid lat_seconds, must be a floating point number between 0 and 60, including 0 but not including 60
                                                                                                                                                        1056Invalid or missing lat_direction. Values must be N or S
                                                                                                                                                        1057Invalid long_degrees, must be an integer between 0 and 180
                                                                                                                                                        1058Invalid long_minutes, must be an integer between 0 and 59
                                                                                                                                                        1059Invalid long_seconds, must be a floating point number between 0 and 60, including 0 but not including 60
                                                                                                                                                        1060Invalid or missing long_direction. Values must be E or S
                                                                                                                                                        1061Invalid altitude, must be a floating point number between -100000.00 and 42849672.95
                                                                                                                                                        1062Invalid size, must be a floating point number between 0 and 90000000.00
                                                                                                                                                        1063Invalid precision_horz, must be a floating point number between 0 and 90000000.00
                                                                                                                                                        1064Invalid precision_vert, must be a floating point number between 0 and 90000000.00
                                                                                                                                                        1065Invalid or missing data for <type> record
                                                                                                                                                        1067Invalid content for a NS record
                                                                                                                                                        1068Target cannot be an IP address
                                                                                                                                                        1069CNAME content cannot reference itself
                                                                                                                                                        1070CNAME content cannot be an IP
                                                                                                                                                        1071Invalid proxied mode. Record cannot be proxied
                                                                                                                                                        1072Invalid record identifier
                                                                                                                                                        1073Invalid TXT record. Must be less than 255 characters
                                                                                                                                                        1074Invalid TXT record. Record may only contain printable ASCII!

                                                                                                                                                        DNS Records for a Zone Notes

                                                                                                                                                        If a zone's cname_setup_status is TRUE, you may only add A/AAAA and CNAME records for that zone
                                                                                                                                                        When adding a CNAME record, it will not be added if there is an A or AAAA record with the same name
                                                                                                                                                        When adding a A or AAAA record, it will not be added if there is an CNAME record with the same name
                                                                                                                                                        A CNAME record's name may not match it's content
                                                                                                                                                        You cannot add an NS record with the same name as any other record type
                                                                                                                                                        You cannot add a record with the same name as any NS record
                                                                                                                                                        Cloudflare will not begin serving DNS for a zone until the zone's nameservers are switched to Cloudflare nameservers at the zone's registrar
                                                                                                                                                        DNS will continue to be served by Cloudflare for 20 days after a zone's nameservers are switched away from Cloudflare namservers
                                                                                                                                                        When using unicode characters in domain names, they will be translated to punycode and as such, the length may end up being larger than what is passed into the API

                                                                                                                                                        DNS Analytics

                                                                                                                                                        Analytics data for a zone.

                                                                                                                                                        $dns-analytics

                                                                                                                                                        Metrics

                                                                                                                                                        A metric is a numerical value that is based on an attribute of the data, for example a query count.

                                                                                                                                                        In API requests, metrics are set in the metrics parameter. If you need to list multiple metrics, separate them with commas.

                                                                                                                                                        MetricNameExampleUnit
                                                                                                                                                        queryCountQuery count1000Count
                                                                                                                                                        uncachedCountUncached query count1Count
                                                                                                                                                        staleCountStale query count1Count
                                                                                                                                                        responseTimeAvgAverage response time1.0Time in milliseconds.
                                                                                                                                                        responseTimeMedianMedian response time1.0Time in milliseconds.
                                                                                                                                                        responseTime90th90th percentile response time1.0Time in milliseconds.
                                                                                                                                                        responseTime99th99th percentile response time1.0Time in milliseconds.

                                                                                                                                                        Dimensions

                                                                                                                                                        Dimensions can be used to break down the data by given attributes.

                                                                                                                                                        In API requests, dimensions are set in the dimensions parameter. If you need to list multiple dimensions, separate them with commas.

                                                                                                                                                        DimensionNameExampleNotes
                                                                                                                                                        queryNameQuery Nameexample.com
                                                                                                                                                        queryTypeQuery TypeAAAATypes defined by IANA, unknown types are empty.
                                                                                                                                                        responseCodeResponse CodeNOERRORResponse codes defined by IANA (always uppercase).
                                                                                                                                                        responseCachedResponse CachedCachedEither Cached or Uncached.
                                                                                                                                                        coloNameColo NameSJCPoP code.
                                                                                                                                                        originOrigin2001:db8::1Origin used to resolve the query (empty if N/A or if the query was answered from cache).
                                                                                                                                                        dayOfWeekDay Of Week1Break down by day of week, (Monday is 1, and Sunday is 7).
                                                                                                                                                        tcpTCP1Either 1 or 0 depending on the protocol used.
                                                                                                                                                        ipVersionIP Version6IP protocol version used (currently 4 or 6).
                                                                                                                                                        querySizeBucketQuery Size Bucket16-31Query size bucket by multiples of 16.
                                                                                                                                                        responseSizeBucketResponse Size Bucket16-31Response size bucket by multiples of 16.

                                                                                                                                                        Filters

                                                                                                                                                        A filter uses the form: dimension operator expression

                                                                                                                                                        In this syntax:

                                                                                                                                                        • name — the name of the dimension or metric to filter on. For example: queryName
                                                                                                                                                        • operator — defines the type of filter match to use. Operators are specific to either dimensions or metrics.
                                                                                                                                                        • expression — states the values to be included in or excluded from the results. Expressions use regular expression syntax

                                                                                                                                                        Filter Operators

                                                                                                                                                        OperatorNameExampleNotesURL Encoded
                                                                                                                                                        ==EqualsqueryName==example.comReturn results where queryName is exactly example.com%3D%3D
                                                                                                                                                        !=Does not equalresponseCode!=NOERRORReturn results where response code is different from NOERROR.!%3D
                                                                                                                                                        >Greater thanqueryCount>1000Return results where query count is higher than 1000%3E
                                                                                                                                                        <Less thanqueryCount<1000Return results where query count is lower than 1000%3C
                                                                                                                                                        >=Greater than or equal toqueryCount>=1000Return results where query count is higher than or equal to 1000%3E%3D
                                                                                                                                                        <=Less than or equal toqueryCount<=1000Return results where query count is lower than or equal to 1000%3C%3D

                                                                                                                                                        Combining Filters

                                                                                                                                                        Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions.

                                                                                                                                                        OR

                                                                                                                                                        The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace.

                                                                                                                                                        Examples:

                                                                                                                                                        • Response code is either NOERROR or NXDOMAIN: responseCode==NOERROR,responseCode==NXDOMAIN
                                                                                                                                                        • Queries in either SJC or LAX: coloName==SJC OR coloName==LAX

                                                                                                                                                        AND

                                                                                                                                                        The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace.

                                                                                                                                                        Examples:

                                                                                                                                                        • Response code is NOERROR and query type is AAAA: responseCode==NOERROR;queryType==AAAA
                                                                                                                                                        • AAAA queries in SJC: queryType==AAAA AND coloName==SJC
                                                                                                                                                        dns-analytics-table

                                                                                                                                                        GET Table

                                                                                                                                                        Retrieves a list of summarised aggregate metrics over a given time period.

                                                                                                                                                        GET zones/:identifier/dns_analytics/report

                                                                                                                                                        Required parameters

                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                        dimensions
                                                                                                                                                        array

                                                                                                                                                        Array of dimensions

                                                                                                                                                        [ "responseCode", "queryName" ]
                                                                                                                                                        An array with items in the following form:
                                                                                                                                                          metrics
                                                                                                                                                          array

                                                                                                                                                          Array of metrics

                                                                                                                                                          [ "queryCount", "responseTimeAvg" ]
                                                                                                                                                          An array with items in the following form:
                                                                                                                                                            since
                                                                                                                                                            string (date-time)

                                                                                                                                                            Start date and time of requesting data period in the ISO8601 format

                                                                                                                                                            "2016-11-11T12:00:00Z"
                                                                                                                                                              until
                                                                                                                                                              string (date-time)

                                                                                                                                                              End date and time of requesting data period in the ISO8601 format

                                                                                                                                                              "2016-11-11T13:00:00Z"

                                                                                                                                                                Optional parameters

                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                sort
                                                                                                                                                                array

                                                                                                                                                                Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)

                                                                                                                                                                [ "+responseCode", "-queryName" ]
                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                  filters
                                                                                                                                                                  string

                                                                                                                                                                  Segmentation filter in 'attribute operator value' format

                                                                                                                                                                  "responseCode==NOERROR"
                                                                                                                                                                    limit
                                                                                                                                                                    integer

                                                                                                                                                                    Limit number of returned metrics, default is 100

                                                                                                                                                                    100
                                                                                                                                                                      cURL (example)
                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                      Response (example)
                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "rows": 100,
    "totals": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "min": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "max": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "data_lag": 60
  }
}
                                                                                                                                                                      dns-analytics-by-time

                                                                                                                                                                      GET By Time

                                                                                                                                                                      Retrieves a list of aggregate metrics grouped by time interval.

                                                                                                                                                                      GET zones/:identifier/dns_analytics/report/bytime

                                                                                                                                                                      Optional parameters

                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                      dimensions
                                                                                                                                                                      array

                                                                                                                                                                      Array of dimensions

                                                                                                                                                                      [ "responseCode", "queryName" ]
                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                        metrics
                                                                                                                                                                        array

                                                                                                                                                                        Array of metrics

                                                                                                                                                                        [ "queryCount", "responseTimeAvg" ]
                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                          sort
                                                                                                                                                                          array

                                                                                                                                                                          Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)

                                                                                                                                                                          [ "+responseCode", "-queryName" ]
                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                            filters
                                                                                                                                                                            string

                                                                                                                                                                            Segmentation filter in 'attribute operator value' format

                                                                                                                                                                            "responseCode==NOERROR"
                                                                                                                                                                              since
                                                                                                                                                                              string (date-time)

                                                                                                                                                                              Start date and time of requesting data period in the ISO8601 format

                                                                                                                                                                              "2016-11-11T12:00:00Z"
                                                                                                                                                                                until
                                                                                                                                                                                string (date-time)

                                                                                                                                                                                End date and time of requesting data period in the ISO8601 format

                                                                                                                                                                                "2016-11-11T13:00:00Z"
                                                                                                                                                                                  limit
                                                                                                                                                                                  integer

                                                                                                                                                                                  Limit number of returned metrics, default is 100

                                                                                                                                                                                  100
                                                                                                                                                                                    time_delta

                                                                                                                                                                                    Unit of time to group data by

                                                                                                                                                                                    "hour"
                                                                                                                                                                                    • valid values: all, auto, year, quarter, month, week, day, hour, dekaminute, minute
                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report/bytime?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100&time_delta=hour" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                    Response (example)
                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "rows": 100,
    "totals": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "min": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "max": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "data_lag": 60
  }
}

                                                                                                                                                                                    DNSSEC

                                                                                                                                                                                    Manage DNSSEC for a zone

                                                                                                                                                                                    dnssec

                                                                                                                                                                                    Object definition

                                                                                                                                                                                    View properties and constraints defined on the object

                                                                                                                                                                                    Show definition

                                                                                                                                                                                    dnssec-dnssec-details

                                                                                                                                                                                    GET DNSSEC Details permission needed: #zone_settings:read
                                                                                                                                                                                    • free
                                                                                                                                                                                    • pro
                                                                                                                                                                                    • business
                                                                                                                                                                                    • enterprise

                                                                                                                                                                                    Details about DNSSEC status and configuration

                                                                                                                                                                                    GET zones/:zone_identifier/dnssec
                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dnssec" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                    Response (example)
                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "status": "active",
    "flags": 257,
    "algorithm": "13",
    "key_type": "ECDSAP256SHA256",
    "digest_type": "2",
    "digest_algorithm": "SHA256",
    "digest": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
    "ds": "example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
    "key_tag": 42,
    "public_key": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==",
    "modified_on": "2014-01-01T05:20:00Z"
  }
}
                                                                                                                                                                                    dnssec-edit-dnssec-status

                                                                                                                                                                                    PATCH Edit DNSSEC Status permission needed: #zone_settings:edit
                                                                                                                                                                                    • free
                                                                                                                                                                                    • pro
                                                                                                                                                                                    • business
                                                                                                                                                                                    • enterprise

                                                                                                                                                                                    Enable or disable DNSSEC

                                                                                                                                                                                    PATCH zones/:zone_identifier/dnssec

                                                                                                                                                                                    Required parameters

                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                    status

                                                                                                                                                                                    Status of DNSSEC, based on user-desired state and presence of necessary records

                                                                                                                                                                                    "active"
                                                                                                                                                                                    • valid values: active, disabled
                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                    curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dnssec" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"status":"active"}'
                                                                                                                                                                                    Response (example)
                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "status": "active",
    "flags": 257,
    "algorithm": "13",
    "key_type": "ECDSAP256SHA256",
    "digest_type": "2",
    "digest_algorithm": "SHA256",
    "digest": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
    "ds": "example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45",
    "key_tag": 42,
    "public_key": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==",
    "modified_on": "2014-01-01T05:20:00Z"
  }
}
                                                                                                                                                                                    dnssec-delete-dnssec-records

                                                                                                                                                                                    DELETE Delete DNSSEC records permission needed: #zone_settings:edit
                                                                                                                                                                                    • free
                                                                                                                                                                                    • pro
                                                                                                                                                                                    • business
                                                                                                                                                                                    • enterprise

                                                                                                                                                                                    Delete DNSSEC

                                                                                                                                                                                    DELETE zones/:zone_identifier/dnssec
                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dnssec" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                    Response (example)
                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": ""
}

                                                                                                                                                                                    DNS Firewall

                                                                                                                                                                                    Account-level DNS Firewall Management

                                                                                                                                                                                    dns-firewall

                                                                                                                                                                                    Object definition

                                                                                                                                                                                    View properties and constraints defined on the object

                                                                                                                                                                                    Show definition

                                                                                                                                                                                    dns-firewall-list-dns-firewall-clusters

                                                                                                                                                                                    GET List DNS Firewall Clusters permission needed: #dns_records:read
                                                                                                                                                                                    • free
                                                                                                                                                                                    • pro
                                                                                                                                                                                    • business
                                                                                                                                                                                    • enterprise

                                                                                                                                                                                    List configured DNS Firewall clusters for an account

                                                                                                                                                                                    GET accounts/:account_identifier/virtual_dns

                                                                                                                                                                                    Optional parameters

                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                    page
                                                                                                                                                                                    number

                                                                                                                                                                                    Page number of paginated results

                                                                                                                                                                                    1
                                                                                                                                                                                    • default value: 1
                                                                                                                                                                                    • min value:1
                                                                                                                                                                                    per_page
                                                                                                                                                                                    number

                                                                                                                                                                                    Number of DNS records per page

                                                                                                                                                                                    20
                                                                                                                                                                                    • default value: 20
                                                                                                                                                                                    • min value:5
                                                                                                                                                                                    • max value:100
                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns?page=1&per_page=20" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                    Response (example)
                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "9a7806061c88ada191ed06f989cc3dac",
      "name": "My Awesome DNS Firewall cluster",
      "origin_ips": [
        "192.0.2.1",
        "198.51.100.1",
        "2001:DB8:100::CF"
      ],
      "virtual_dns_ips": [
        "203.0.113.1",
        "203.0.113.254",
        "2001:DB8:AB::CF",
        "2001:DB8:CD::CF"
      ],
      "minimum_cache_ttl": 60,
      "maximum_cache_ttl": 900,
      "negative_cache_ttl": 900,
      "deprecate_any_requests": true,
      "ecs_fallback": false,
      "ratelimit": 600,
      "modified_on": "2014-01-01T05:20:00.12345Z"
    }
  ]
}
                                                                                                                                                                                    dns-firewall-dns-firewall-cluster-details

                                                                                                                                                                                    GET DNS Firewall Cluster Details permission needed: #dns_records:read
                                                                                                                                                                                    • free
                                                                                                                                                                                    • pro
                                                                                                                                                                                    • business
                                                                                                                                                                                    • enterprise

                                                                                                                                                                                    List a single configured DNS Firewall clusters for an account

                                                                                                                                                                                    GET accounts/:account_identifier/virtual_dns/:identifier
                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                    Response (example)
                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "name": "My Awesome DNS Firewall cluster",
    "origin_ips": [
      "192.0.2.1",
      "198.51.100.1",
      "2001:DB8:100::CF"
    ],
    "virtual_dns_ips": [
      "203.0.113.1",
      "203.0.113.254",
      "2001:DB8:AB::CF",
      "2001:DB8:CD::CF"
    ],
    "minimum_cache_ttl": 60,
    "maximum_cache_ttl": 900,
    "negative_cache_ttl": 900,
    "deprecate_any_requests": true,
    "ecs_fallback": false,
    "ratelimit": 600,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                    dns-firewall-update-dns-firewall-cluster

                                                                                                                                                                                    PUT Update DNS Firewall Cluster permission needed: #dns_records:edit
                                                                                                                                                                                    • free
                                                                                                                                                                                    • pro
                                                                                                                                                                                    • business
                                                                                                                                                                                    • enterprise

                                                                                                                                                                                    Modify a DNS Firewall Cluster configuration

                                                                                                                                                                                    PUT accounts/:account_identifier/virtual_dns/:identifier

                                                                                                                                                                                    Optional parameters

                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                    virtual_dns_ips
                                                                                                                                                                                    array
                                                                                                                                                                                    [ "203.0.113.1", "203.0.113.254", "2001:DB8:AB::CF", "2001:DB8:CD::CF" ]
                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                      negative_cache_ttl
                                                                                                                                                                                      numbernull

                                                                                                                                                                                      Negative DNS Cache TTL

                                                                                                                                                                                      900
                                                                                                                                                                                      • default value: 900
                                                                                                                                                                                      • min value:30
                                                                                                                                                                                      • max value:36000
                                                                                                                                                                                      deprecate_any_requests
                                                                                                                                                                                      boolean

                                                                                                                                                                                      Deprecate the response to ANY requests

                                                                                                                                                                                      true
                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                      name
                                                                                                                                                                                      string

                                                                                                                                                                                      DNS Firewall Cluster Name

                                                                                                                                                                                      "My Awesome DNS Firewall cluster"
                                                                                                                                                                                      • max length: 160
                                                                                                                                                                                      ecs_fallback
                                                                                                                                                                                      boolean

                                                                                                                                                                                      Forward client IP (resolver) subnet if no EDNS Client Subnet is sent

                                                                                                                                                                                      false
                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                      maximum_cache_ttl
                                                                                                                                                                                      number

                                                                                                                                                                                      Maximum DNS Cache TTL

                                                                                                                                                                                      900
                                                                                                                                                                                      • default value: 900
                                                                                                                                                                                      • min value:30
                                                                                                                                                                                      • max value:36000
                                                                                                                                                                                      origin_ips
                                                                                                                                                                                      array
                                                                                                                                                                                      [ "192.0.2.1", "198.51.100.1", "2001:DB8:100::CF" ]
                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                        modified_on
                                                                                                                                                                                        string (date-time)

                                                                                                                                                                                        Last modification of DNS Firewall cluster

                                                                                                                                                                                        "2014-01-01T05:20:00.12345Z"
                                                                                                                                                                                        • read only
                                                                                                                                                                                        id
                                                                                                                                                                                        string

                                                                                                                                                                                        API item identifier tag

                                                                                                                                                                                        "9a7806061c88ada191ed06f989cc3dac"
                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                        • read only
                                                                                                                                                                                        ratelimit
                                                                                                                                                                                        number

                                                                                                                                                                                        Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).

                                                                                                                                                                                        600
                                                                                                                                                                                        • max value:100000000
                                                                                                                                                                                        • notes: A ratelimit of 0 turns off the ratelimit. Otherwise the minimum is 100.
                                                                                                                                                                                        minimum_cache_ttl
                                                                                                                                                                                        number

                                                                                                                                                                                        Minimum DNS Cache TTL

                                                                                                                                                                                        60
                                                                                                                                                                                        • default value: 60
                                                                                                                                                                                        • min value:30
                                                                                                                                                                                        • max value:36000
                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"9a7806061c88ada191ed06f989cc3dac","name":"My Awesome DNS Firewall cluster","origin_ips":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"virtual_dns_ips":["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"],"minimum_cache_ttl":60,"maximum_cache_ttl":900,"negative_cache_ttl":900,"deprecate_any_requests":true,"ecs_fallback":false,"ratelimit":600,"modified_on":"2014-01-01T05:20:00.12345Z"}'
                                                                                                                                                                                        Response (example)
                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "name": "My Awesome DNS Firewall cluster",
    "origin_ips": [
      "192.0.2.1",
      "198.51.100.1",
      "2001:DB8:100::CF"
    ],
    "virtual_dns_ips": [
      "203.0.113.1",
      "203.0.113.254",
      "2001:DB8:AB::CF",
      "2001:DB8:CD::CF"
    ],
    "minimum_cache_ttl": 60,
    "maximum_cache_ttl": 900,
    "negative_cache_ttl": 900,
    "deprecate_any_requests": true,
    "ecs_fallback": false,
    "ratelimit": 600,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                        dns-firewall-delete-dns-firewall-cluster

                                                                                                                                                                                        DELETE Delete DNS Firewall Cluster permission needed: #dns_records:edit
                                                                                                                                                                                        • free
                                                                                                                                                                                        • pro
                                                                                                                                                                                        • business
                                                                                                                                                                                        • enterprise

                                                                                                                                                                                        Delete a configured DNS Firewall Cluster

                                                                                                                                                                                        DELETE accounts/:account_identifier/virtual_dns/:identifier
                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                        Response (example)
                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                        dns-firewall-create-dns-firewall-cluster

                                                                                                                                                                                        POST Create DNS Firewall Cluster permission needed: #dns_records:edit
                                                                                                                                                                                        • free
                                                                                                                                                                                        • pro
                                                                                                                                                                                        • business
                                                                                                                                                                                        • enterprise

                                                                                                                                                                                        Create a configured DNS Firewall Cluster

                                                                                                                                                                                        POST accounts/:account_identifier/virtual_dns

                                                                                                                                                                                        Required parameters

                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                        name
                                                                                                                                                                                        string

                                                                                                                                                                                        DNS Firewall Cluster Name

                                                                                                                                                                                        "My Awesome DNS Firewall cluster"
                                                                                                                                                                                        • max length: 160
                                                                                                                                                                                        origin_ips
                                                                                                                                                                                        array
                                                                                                                                                                                        [ "192.0.2.1", "198.51.100.1", "2001:DB8:100::CF" ]
                                                                                                                                                                                        An array with items in the following form:

                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                          minimum_cache_ttl
                                                                                                                                                                                          number

                                                                                                                                                                                          Minimum DNS Cache TTL

                                                                                                                                                                                          60
                                                                                                                                                                                          • default value: 60
                                                                                                                                                                                          • min value:30
                                                                                                                                                                                          • max value:36000
                                                                                                                                                                                          maximum_cache_ttl
                                                                                                                                                                                          number

                                                                                                                                                                                          Maximum DNS Cache TTL

                                                                                                                                                                                          900
                                                                                                                                                                                          • default value: 900
                                                                                                                                                                                          • min value:30
                                                                                                                                                                                          • max value:36000
                                                                                                                                                                                          negative_cache_ttl
                                                                                                                                                                                          numbernull

                                                                                                                                                                                          Negative DNS Cache TTL

                                                                                                                                                                                          900
                                                                                                                                                                                          • default value: 900
                                                                                                                                                                                          • min value:30
                                                                                                                                                                                          • max value:36000
                                                                                                                                                                                          deprecate_any_requests
                                                                                                                                                                                          boolean

                                                                                                                                                                                          Deprecate the response to ANY requests

                                                                                                                                                                                          true
                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                          ecs_fallback
                                                                                                                                                                                          boolean

                                                                                                                                                                                          Forward client IP (resolver) subnet if no EDNS Client Subnet is sent

                                                                                                                                                                                          false
                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                          ratelimit
                                                                                                                                                                                          number

                                                                                                                                                                                          Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).

                                                                                                                                                                                          600
                                                                                                                                                                                          • max value:100000000
                                                                                                                                                                                          • notes: A ratelimit of 0 turns off the ratelimit. Otherwise the minimum is 100.
                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"My Awesome DNS Firewall cluster","origin_ips":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"minimum_cache_ttl":60,"maximum_cache_ttl":900,"negative_cache_ttl":900,"deprecate_any_requests":true,"ecs_fallback":false,"ratelimit":600}'
                                                                                                                                                                                          Response (example)
                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "name": "My Awesome DNS Firewall cluster",
    "origin_ips": [
      "192.0.2.1",
      "198.51.100.1",
      "2001:DB8:100::CF"
    ],
    "virtual_dns_ips": [
      "203.0.113.1",
      "203.0.113.254",
      "2001:DB8:AB::CF",
      "2001:DB8:CD::CF"
    ],
    "minimum_cache_ttl": 60,
    "maximum_cache_ttl": 900,
    "negative_cache_ttl": 900,
    "deprecate_any_requests": true,
    "ecs_fallback": false,
    "ratelimit": 600,
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}

                                                                                                                                                                                          DNS Firewall Analytics

                                                                                                                                                                                          Analytics data for a DNS Firewall cluster.

                                                                                                                                                                                          dns-firewall-analytics

                                                                                                                                                                                          Object definition

                                                                                                                                                                                          View properties and constraints defined on the object

                                                                                                                                                                                          Show definition

                                                                                                                                                                                          dns-firewall-analytics-table

                                                                                                                                                                                          GET Table

                                                                                                                                                                                          Retrieves a list of summarised aggregate metrics over a given time period.

                                                                                                                                                                                          GET accounts/:account_identifier/virtual_dns/:identifier/dns_analytics/report

                                                                                                                                                                                          Required parameters

                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                          dimensions
                                                                                                                                                                                          array

                                                                                                                                                                                          Array of dimensions

                                                                                                                                                                                          [ "responseCode", "queryName" ]
                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                            metrics
                                                                                                                                                                                            array

                                                                                                                                                                                            Array of metrics

                                                                                                                                                                                            [ "queryCount", "responseTimeAvg" ]
                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                              since
                                                                                                                                                                                              string (date-time)

                                                                                                                                                                                              Start date and time of requesting data period in the ISO8601 format

                                                                                                                                                                                              "2016-11-11T12:00:00Z"
                                                                                                                                                                                                until
                                                                                                                                                                                                string (date-time)

                                                                                                                                                                                                End date and time of requesting data period in the ISO8601 format

                                                                                                                                                                                                "2016-11-11T13:00:00Z"

                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                  sort
                                                                                                                                                                                                  array

                                                                                                                                                                                                  Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)

                                                                                                                                                                                                  [ "+responseCode", "-queryName" ]
                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                    filters
                                                                                                                                                                                                    string

                                                                                                                                                                                                    Segmentation filter in 'attribute operator value' format

                                                                                                                                                                                                    "responseCode==NOERROR"
                                                                                                                                                                                                      limit
                                                                                                                                                                                                      integer

                                                                                                                                                                                                      Limit number of returned metrics, default is 100

                                                                                                                                                                                                      100
                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "rows": 100,
    "totals": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "min": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "max": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "data_lag": 60
  }
}
                                                                                                                                                                                                        dns-firewall-analytics-by-time

                                                                                                                                                                                                        GET By Time

                                                                                                                                                                                                        Retrieves a list of aggregate metrics grouped by time interval.

                                                                                                                                                                                                        GET accounts/:account_identifier/virtual_dns/:identifier/dns_analytics/report/bytime

                                                                                                                                                                                                        Optional parameters

                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                        dimensions
                                                                                                                                                                                                        array

                                                                                                                                                                                                        Array of dimensions

                                                                                                                                                                                                        [ "responseCode", "queryName" ]
                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                          metrics
                                                                                                                                                                                                          array

                                                                                                                                                                                                          Array of metrics

                                                                                                                                                                                                          [ "queryCount", "responseTimeAvg" ]
                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                            sort
                                                                                                                                                                                                            array

                                                                                                                                                                                                            Array of dimensions to sort by, each dimension may be prefixed by - (descending) or + (ascending)

                                                                                                                                                                                                            [ "+responseCode", "-queryName" ]
                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                              filters
                                                                                                                                                                                                              string

                                                                                                                                                                                                              Segmentation filter in 'attribute operator value' format

                                                                                                                                                                                                              "responseCode==NOERROR"
                                                                                                                                                                                                                since
                                                                                                                                                                                                                string (date-time)

                                                                                                                                                                                                                Start date and time of requesting data period in the ISO8601 format

                                                                                                                                                                                                                "2016-11-11T12:00:00Z"
                                                                                                                                                                                                                  until
                                                                                                                                                                                                                  string (date-time)

                                                                                                                                                                                                                  End date and time of requesting data period in the ISO8601 format

                                                                                                                                                                                                                  "2016-11-11T13:00:00Z"
                                                                                                                                                                                                                    limit
                                                                                                                                                                                                                    integer

                                                                                                                                                                                                                    Limit number of returned metrics, default is 100

                                                                                                                                                                                                                    100
                                                                                                                                                                                                                      time_delta

                                                                                                                                                                                                                      Unit of time to group data by

                                                                                                                                                                                                                      "hour"
                                                                                                                                                                                                                      • valid values: all, auto, year, quarter, month, week, day, hour, dekaminute, minute
                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/virtual_dns/9a7806061c88ada191ed06f989cc3dac/dns_analytics/report/bytime?dimensions=responseCode,queryName&metrics=queryCount,responseTimeAvg&sort=+responseCode,-queryName&filters=responseCode==NOERROR&since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&limit=100&time_delta=hour" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "rows": 100,
    "totals": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "min": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "max": {
      "queryCount": 1000,
      "responseTimeAvg": 1
    },
    "data_lag": 60
  }
}

                                                                                                                                                                                                                      Secondary DNS

                                                                                                                                                                                                                      Secondary DNS Zone

                                                                                                                                                                                                                      secondary-dns

                                                                                                                                                                                                                      Object definition

                                                                                                                                                                                                                      View properties and constraints defined on the object

                                                                                                                                                                                                                      Show definition

                                                                                                                                                                                                                      secondary-dns-secondary-zone-configuration-details

                                                                                                                                                                                                                      GET Secondary Zone Configuration Details permission needed: #dns_records:read
                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                      • enterprise

                                                                                                                                                                                                                      Get secondary zone configuration

                                                                                                                                                                                                                      GET zones/:identifier/secondary_dns
                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "primaries": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "auto_refresh_seconds": 86400,
    "soa_serial": 2019102400,
    "created_time": "2019-10-24T17:09:42.883908+01:00",
    "checked_time": "2019-10-24T17:09:42.883908+01:00",
    "modified_time": "2019-10-24T17:09:42.883908+01:00"
  }
}
                                                                                                                                                                                                                      secondary-dns-update-secondary-zone-configuration

                                                                                                                                                                                                                      PUT Update Secondary Zone Configuration permission needed: #dns_records:edit
                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                      • enterprise

                                                                                                                                                                                                                      Update secondary zone configuration

                                                                                                                                                                                                                      PUT zones/:identifier/secondary_dns

                                                                                                                                                                                                                      Required parameters

                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                      id
                                                                                                                                                                                                                      string

                                                                                                                                                                                                                      API item identifier tag

                                                                                                                                                                                                                      "269d8f4853475ca241c4e730be286b20"
                                                                                                                                                                                                                      • max length: 32
                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                      name
                                                                                                                                                                                                                      string

                                                                                                                                                                                                                      zone name

                                                                                                                                                                                                                      "www.example.com."
                                                                                                                                                                                                                        primaries
                                                                                                                                                                                                                        array

                                                                                                                                                                                                                        A list of primary tags

                                                                                                                                                                                                                        [ "23ff594956f20c2a721606e94745a8aa", "00920f38ce07c2e2f4df50b1f61d4194" ]
                                                                                                                                                                                                                          auto_refresh_seconds
                                                                                                                                                                                                                          number

                                                                                                                                                                                                                          How often should it auto refresh regardless of DNS notify

                                                                                                                                                                                                                          86400
                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"269d8f4853475ca241c4e730be286b20","name":"www.example.com.","primaries":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"auto_refresh_seconds":86400}'
                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "primaries": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "auto_refresh_seconds": 86400,
    "soa_serial": 2019102400,
    "created_time": "2019-10-24T17:09:42.883908+01:00",
    "checked_time": "2019-10-24T17:09:42.883908+01:00",
    "modified_time": "2019-10-24T17:09:42.883908+01:00"
  }
}
                                                                                                                                                                                                                            secondary-dns-delete-secondary-zone-configuration

                                                                                                                                                                                                                            DELETE Delete Secondary Zone Configuration permission needed: #dns_records:edit
                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                            Delete secondary zone configuration

                                                                                                                                                                                                                            DELETE zones/:identifier/secondary_dns
                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "269d8f4853475ca241c4e730be286b20"
  }
}
                                                                                                                                                                                                                            secondary-dns-create-secondary-zone-configuration

                                                                                                                                                                                                                            POST Create Secondary Zone Configuration permission needed: #dns_records:edit
                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                            Create secondary zone configuration

                                                                                                                                                                                                                            POST zones/:identifier/secondary_dns

                                                                                                                                                                                                                            Required parameters

                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                            id
                                                                                                                                                                                                                            string

                                                                                                                                                                                                                            API item identifier tag

                                                                                                                                                                                                                            "269d8f4853475ca241c4e730be286b20"
                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                            name
                                                                                                                                                                                                                            string

                                                                                                                                                                                                                            zone name

                                                                                                                                                                                                                            "www.example.com."
                                                                                                                                                                                                                              primaries
                                                                                                                                                                                                                              array

                                                                                                                                                                                                                              A list of primary tags

                                                                                                                                                                                                                              [ "23ff594956f20c2a721606e94745a8aa", "00920f38ce07c2e2f4df50b1f61d4194" ]
                                                                                                                                                                                                                                auto_refresh_seconds
                                                                                                                                                                                                                                number

                                                                                                                                                                                                                                How often should it auto refresh regardless of DNS notify

                                                                                                                                                                                                                                86400
                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"269d8f4853475ca241c4e730be286b20","name":"www.example.com.","primaries":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"auto_refresh_seconds":86400}'
                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "269d8f4853475ca241c4e730be286b20",
    "name": "www.example.com.",
    "primaries": [
      "23ff594956f20c2a721606e94745a8aa",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "auto_refresh_seconds": 86400,
    "soa_serial": 2019102400,
    "created_time": "2019-10-24T17:09:42.883908+01:00",
    "checked_time": "2019-10-24T17:09:42.883908+01:00",
    "modified_time": "2019-10-24T17:09:42.883908+01:00"
  }
}
                                                                                                                                                                                                                                  secondary-dns-force-secondary-zone-axfr

                                                                                                                                                                                                                                  POST Force Secondary Zone AXFR permission needed: #dns_records:edit
                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                  Force Secondary Zone AXFR

                                                                                                                                                                                                                                  POST zones/:identifier/secondary_dns/force_axfr
                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/zones/269d8f4853475ca241c4e730be286b20/secondary_dns/force_axfr" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": "OK"
}

                                                                                                                                                                                                                                  Secondary DNS (TSIG)

                                                                                                                                                                                                                                  TSIG key management for secondary DNS

                                                                                                                                                                                                                                  secondary-dns-tsig-

                                                                                                                                                                                                                                  Object definition

                                                                                                                                                                                                                                  View properties and constraints defined on the object

                                                                                                                                                                                                                                  Show definition

                                                                                                                                                                                                                                  secondary-dns-tsig--list-tsigs

                                                                                                                                                                                                                                  GET List TSIGs permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                  List TSIGs

                                                                                                                                                                                                                                  GET accounts/:account_identifier/secondary_dns/tsigs
                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "69cd1e104af3e6ed3cb344f263fd0d5a",
      "name": "tsig.customer.cf.",
      "secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
      "algo": "hmac-sha512."
    }
  ]
}
                                                                                                                                                                                                                                  secondary-dns-tsig--tsig-details

                                                                                                                                                                                                                                  GET TSIG Details permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                  Get TSIG

                                                                                                                                                                                                                                  GET accounts/:account_identifier/secondary_dns/tsigs/:identifier
                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs/69cd1e104af3e6ed3cb344f263fd0d5a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "tsig.customer.cf.",
    "secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
    "algo": "hmac-sha512."
  }
}
                                                                                                                                                                                                                                  secondary-dns-tsig--update-tsig

                                                                                                                                                                                                                                  PUT Update TSIG permission needed: #dns_records:edit#organization:read
                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                  Modify TSIG

                                                                                                                                                                                                                                  PUT accounts/:account_identifier/secondary_dns/tsigs/:identifier

                                                                                                                                                                                                                                  Required parameters

                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                  id
                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                  API item identifier tag

                                                                                                                                                                                                                                  "69cd1e104af3e6ed3cb344f263fd0d5a"
                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                  TSIG key name

                                                                                                                                                                                                                                  "tsig.customer.cf."
                                                                                                                                                                                                                                    secret
                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                    TSIG secret

                                                                                                                                                                                                                                    "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c"
                                                                                                                                                                                                                                      algo
                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                      TSIG algorithm

                                                                                                                                                                                                                                      "hmac-sha512."
                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs/69cd1e104af3e6ed3cb344f263fd0d5a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"69cd1e104af3e6ed3cb344f263fd0d5a","name":"tsig.customer.cf.","secret":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c","algo":"hmac-sha512."}'
                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "tsig.customer.cf.",
    "secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
    "algo": "hmac-sha512."
  }
}
                                                                                                                                                                                                                                        secondary-dns-tsig--delete-tsig

                                                                                                                                                                                                                                        DELETE Delete TSIG permission needed: #dns_records:edit#organization:read
                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                        Delete TSIG

                                                                                                                                                                                                                                        DELETE accounts/:account_identifier/secondary_dns/tsigs/:identifier
                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs/69cd1e104af3e6ed3cb344f263fd0d5a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "69cd1e104af3e6ed3cb344f263fd0d5a"
  }
}
                                                                                                                                                                                                                                        secondary-dns-tsig--create-tsig

                                                                                                                                                                                                                                        POST Create TSIG permission needed: #dns_records:edit#organization:read
                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                        Create TSIG

                                                                                                                                                                                                                                        POST accounts/:account_identifier/secondary_dns/tsigs

                                                                                                                                                                                                                                        Required parameters

                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                        TSIG key name

                                                                                                                                                                                                                                        "tsig.customer.cf."
                                                                                                                                                                                                                                          secret
                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                          TSIG secret

                                                                                                                                                                                                                                          "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c"
                                                                                                                                                                                                                                            algo
                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                            TSIG algorithm

                                                                                                                                                                                                                                            "hmac-sha512."
                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/tsigs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"tsig.customer.cf.","secret":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c","algo":"hmac-sha512."}'
                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "tsig.customer.cf.",
    "secret": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c",
    "algo": "hmac-sha512."
  }
}

                                                                                                                                                                                                                                              Secondary DNS (Primary)

                                                                                                                                                                                                                                              Primary nameservers for secondary DNS

                                                                                                                                                                                                                                              secondary-dns-primary-

                                                                                                                                                                                                                                              Object definition

                                                                                                                                                                                                                                              View properties and constraints defined on the object

                                                                                                                                                                                                                                              Show definition

                                                                                                                                                                                                                                              secondary-dns-primary--list-primaries

                                                                                                                                                                                                                                              GET List Primaries permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                              List Primaries

                                                                                                                                                                                                                                              GET accounts/:account_identifier/secondary_dns/primaries
                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/primaries" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "23ff594956f20c2a721606e94745a8aa",
      "ip": "192.0.2.53",
      "port": 53,
      "ixfr_enable": false,
      "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
      "name": "my-primary-1"
    }
  ]
}
                                                                                                                                                                                                                                              secondary-dns-primary--primary-details

                                                                                                                                                                                                                                              GET Primary Details permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                              Get Primary

                                                                                                                                                                                                                                              GET accounts/:account_identifier/secondary_dns/primaries/:identifier
                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/primaries/23ff594956f20c2a721606e94745a8aa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "23ff594956f20c2a721606e94745a8aa",
    "ip": "192.0.2.53",
    "port": 53,
    "ixfr_enable": false,
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "my-primary-1"
  }
}
                                                                                                                                                                                                                                              secondary-dns-primary--update-primary

                                                                                                                                                                                                                                              PUT Update Primary permission needed: #dns_records:edit#organization:read
                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                              Modify Primary

                                                                                                                                                                                                                                              PUT accounts/:account_identifier/secondary_dns/primaries/:identifier

                                                                                                                                                                                                                                              Required parameters

                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                              id
                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                              API item identifier tag

                                                                                                                                                                                                                                              "23ff594956f20c2a721606e94745a8aa"
                                                                                                                                                                                                                                              • max length: 32
                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                              ip
                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                              IPv4/IPv6 address of primary nameserver

                                                                                                                                                                                                                                              "192.0.2.53"
                                                                                                                                                                                                                                                port
                                                                                                                                                                                                                                                number

                                                                                                                                                                                                                                                DNS port of primary nameserver

                                                                                                                                                                                                                                                53

                                                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                  ixfr_enable
                                                                                                                                                                                                                                                  boolean

                                                                                                                                                                                                                                                  Enable IXFR transfer protocol, default is AXFR

                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                  tsig_id
                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                  TSIG authentication will be used for zone transfer if configured

                                                                                                                                                                                                                                                  "69cd1e104af3e6ed3cb344f263fd0d5a"
                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                    The name of the primary

                                                                                                                                                                                                                                                    "my-primary-1"
                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/primaries/23ff594956f20c2a721606e94745a8aa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"23ff594956f20c2a721606e94745a8aa","ip":"192.0.2.53","port":53,"ixfr_enable":false,"tsig_id":"69cd1e104af3e6ed3cb344f263fd0d5a","name":"my-primary-1"}'
                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "23ff594956f20c2a721606e94745a8aa",
    "ip": "192.0.2.53",
    "port": 53,
    "ixfr_enable": false,
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "my-primary-1"
  }
}
                                                                                                                                                                                                                                                      secondary-dns-primary--delete-primary

                                                                                                                                                                                                                                                      DELETE Delete Primary permission needed: #dns_records:edit#organization:read
                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                      • enterprise

                                                                                                                                                                                                                                                      Delete Primary

                                                                                                                                                                                                                                                      DELETE accounts/:account_identifier/secondary_dns/primaries/:identifier
                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/primaries/23ff594956f20c2a721606e94745a8aa" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "23ff594956f20c2a721606e94745a8aa"
  }
}
                                                                                                                                                                                                                                                      secondary-dns-primary--create-primary

                                                                                                                                                                                                                                                      POST Create Primary permission needed: #dns_records:edit#organization:read
                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                      • enterprise

                                                                                                                                                                                                                                                      Create Primary

                                                                                                                                                                                                                                                      POST accounts/:account_identifier/secondary_dns/primaries

                                                                                                                                                                                                                                                      Required parameters

                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                      ip
                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                      IPv4/IPv6 address of primary nameserver

                                                                                                                                                                                                                                                      "192.0.2.53"
                                                                                                                                                                                                                                                        port
                                                                                                                                                                                                                                                        number

                                                                                                                                                                                                                                                        DNS port of primary nameserver

                                                                                                                                                                                                                                                        53

                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                          ixfr_enable
                                                                                                                                                                                                                                                          boolean

                                                                                                                                                                                                                                                          Enable IXFR transfer protocol, default is AXFR

                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                          tsig_id
                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                          TSIG authentication will be used for zone transfer if configured

                                                                                                                                                                                                                                                          "69cd1e104af3e6ed3cb344f263fd0d5a"
                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                                            The name of the primary

                                                                                                                                                                                                                                                            "my-primary-1"
                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/secondary_dns/primaries" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"ip":"192.0.2.53","port":53,"ixfr_enable":false,"tsig_id":"69cd1e104af3e6ed3cb344f263fd0d5a","name":"my-primary-1"}'
                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "23ff594956f20c2a721606e94745a8aa",
    "ip": "192.0.2.53",
    "port": 53,
    "ixfr_enable": false,
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a",
    "name": "my-primary-1"
  }
}

                                                                                                                                                                                                                                                              Cloudflare IPs

                                                                                                                                                                                                                                                              Cloudflare IP space

                                                                                                                                                                                                                                                              cloudflare-ips

                                                                                                                                                                                                                                                              Object definition

                                                                                                                                                                                                                                                              View properties and constraints defined on the object

                                                                                                                                                                                                                                                              Show definition

                                                                                                                                                                                                                                                              cloudflare-ips-cloudflare-ip-details

                                                                                                                                                                                                                                                              GET Cloudflare IP Details

                                                                                                                                                                                                                                                              Get Cloudflare IPs

                                                                                                                                                                                                                                                              GET ips
                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/ips"
                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "ipv4_cidrs": [
      "199.27.128.0/21"
    ],
    "ipv6_cidrs": [
      "2400:cb00::/32"
    ],
    "etag": "a8e453d9d129a3769407127936edfdb0"
  }
}

                                                                                                                                                                                                                                                              Account-Level Custom Nameservers

                                                                                                                                                                                                                                                              Configure custom nameservers that can be used by multiple zones in the account

                                                                                                                                                                                                                                                              account-level-custom-nameservers

                                                                                                                                                                                                                                                              Object definitions

                                                                                                                                                                                                                                                              View properties and constraints defined on the object

                                                                                                                                                                                                                                                              Show definitions

                                                                                                                                                                                                                                                              account-level-custom-nameservers-list-account-custom-nameservers

                                                                                                                                                                                                                                                              GET List Account Custom Nameservers permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                                              List an account's custom nameservers

                                                                                                                                                                                                                                                              GET accounts/:identifier/custom_ns
                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/372e67954025e0ba6aaa6d586b9e0b59/custom_ns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "dns_records": [
        {
          "type": "A",
          "value": "1.1.1.1"
        }
      ],
      "ns_name": "ns1.example.com",
      "status": "verified",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
    }
  ]
}
                                                                                                                                                                                                                                                              account-level-custom-nameservers-add-account-custom-nameserver

                                                                                                                                                                                                                                                              POST Add Account Custom Nameserver permission needed: #dns_records:edit#organization:edit
                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                                              POST accounts/:identifier/custom_ns

                                                                                                                                                                                                                                                              Required parameters

                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                              ns_name
                                                                                                                                                                                                                                                              string (hostname)

                                                                                                                                                                                                                                                              The FQDN of the name server

                                                                                                                                                                                                                                                              "ns1.example.com"
                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/372e67954025e0ba6aaa6d586b9e0b59/custom_ns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"ns_name":"ns1.example.com"}'
                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "dns_records": [
      {
        "type": "A",
        "value": "1.1.1.1"
      }
    ],
    "ns_name": "ns1.example.com",
    "status": "verified",
    "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}
                                                                                                                                                                                                                                                                account-level-custom-nameservers-verify-account-custom-nameserver-glue-records

                                                                                                                                                                                                                                                                POST Verify Account Custom Nameserver Glue Records permission needed: #dns_records:edit#organization:edit
                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                POST accounts/:identifier/custom_ns/verify
                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/372e67954025e0ba6aaa6d586b9e0b59/custom_ns/verify" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "dns_records": [
        {
          "type": "A",
          "value": "1.1.1.1"
        }
      ],
      "ns_name": "ns1.example.com",
      "status": "verified",
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353"
    }
  ]
}
                                                                                                                                                                                                                                                                account-level-custom-nameservers-delete-account-custom-nameserver

                                                                                                                                                                                                                                                                DELETE Delete Account Custom Nameserver permission needed: #dns_records:edit#organization:edit
                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                DELETE accounts/:identifier/custom_ns/:ns_name
                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/372e67954025e0ba6aaa6d586b9e0b59/custom_ns/ns1.example.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers

                                                                                                                                                                                                                                                                GET Get Eligible Zones for Account Custom Nameservers permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                GET accounts/:identifier/custom_ns/availability
                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/372e67954025e0ba6aaa6d586b9e0b59/custom_ns/availability" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    "example.com"
  ]
}

                                                                                                                                                                                                                                                                Account-Level Custom Nameservers error codes

                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                1000Unknown error
                                                                                                                                                                                                                                                                1001Invalid request
                                                                                                                                                                                                                                                                1002Account does not have access to this feature
                                                                                                                                                                                                                                                                1003Not found

                                                                                                                                                                                                                                                                Account-Level Custom Nameservers Notes

                                                                                                                                                                                                                                                                If you want new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.

                                                                                                                                                                                                                                                                Account-Level Custom Nameservers Usage for a Zone

                                                                                                                                                                                                                                                                Per-zone usage of Cloudflare account-level custom nameservers

                                                                                                                                                                                                                                                                account-level-custom-nameservers-usage-for-a-zone

                                                                                                                                                                                                                                                                Object definitions

                                                                                                                                                                                                                                                                View properties and constraints defined on the object

                                                                                                                                                                                                                                                                Show definitions

                                                                                                                                                                                                                                                                account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata

                                                                                                                                                                                                                                                                GET Get Account Custom Nameserver Related Zone Metadata permission needed: #dns_records:read#organization:read
                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                GET zones/:zone_identifier/custom_ns
                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_ns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "enabled": true
  }
}
                                                                                                                                                                                                                                                                account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata

                                                                                                                                                                                                                                                                PUT Set Account Custom Nameserver Related Zone Metadata permission needed: #dns_records:edit#organization:edit
                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                PUT zones/:zone_identifier/custom_ns

                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                result
                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                { "enabled": true }
                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_ns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"result":{"enabled":true}}'
                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}

                                                                                                                                                                                                                                                                  Account-Level Custom Nameservers Usage for a Zone error codes

                                                                                                                                                                                                                                                                  CodeDescription
                                                                                                                                                                                                                                                                  1000Unknown error
                                                                                                                                                                                                                                                                  1001Invalid request
                                                                                                                                                                                                                                                                  1002Account does not have access to this feature
                                                                                                                                                                                                                                                                  1003Not found

                                                                                                                                                                                                                                                                  Custom Pages for a Zone

                                                                                                                                                                                                                                                                  Custom pages associated with a zone

                                                                                                                                                                                                                                                                  custom-pages-for-a-zone

                                                                                                                                                                                                                                                                  Object definitions

                                                                                                                                                                                                                                                                  View properties and constraints defined on the object

                                                                                                                                                                                                                                                                  Show definitions

                                                                                                                                                                                                                                                                  custom-pages-for-a-zone-list-available-custom-pages

                                                                                                                                                                                                                                                                  GET List Available Custom Pages permission needed: #zone_settings:read
                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                  A list of available Custom Pages the zone can use

                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/custom_pages
                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_pages" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "basic_challenge",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "url": "http://www.example.com",
      "state": "default",
      "required_tokens": [
        "::CAPTCHA_BOX::"
      ],
      "preview_target": "preview:target",
      "description": true
    }
  ]
}
                                                                                                                                                                                                                                                                  custom-pages-for-a-zone-custom-page-details

                                                                                                                                                                                                                                                                  GET Custom Page Details permission needed: #zone_settings:read
                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                  Details about a specific Custom page details

                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/custom_pages/:identifier
                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_pages/basic_challenge" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "url": "http://www.example.com",
    "state": "default",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "preview_target": "preview:target",
    "description": true
  }
}
                                                                                                                                                                                                                                                                  custom-pages-for-a-zone-update-custom-page-url

                                                                                                                                                                                                                                                                  PUT Update Custom Page URL permission needed: #zone_settings:edit
                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                  Update custom page URL

                                                                                                                                                                                                                                                                  PUT zones/:zone_identifier/custom_pages/:identifier

                                                                                                                                                                                                                                                                  Required parameters

                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                  url
                                                                                                                                                                                                                                                                  string (url)

                                                                                                                                                                                                                                                                  A URL that is associated with the Custom Page.

                                                                                                                                                                                                                                                                  "http://www.example.com"
                                                                                                                                                                                                                                                                  • default value:
                                                                                                                                                                                                                                                                  state
                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                  The Custom Page state

                                                                                                                                                                                                                                                                  "default"
                                                                                                                                                                                                                                                                  • valid values: default, customized
                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_pages/basic_challenge" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"url":"http://www.example.com","state":"default"}'
                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "url": "http://www.example.com",
    "state": "default",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "preview_target": "preview:target",
    "description": true
  }
}

                                                                                                                                                                                                                                                                  Custom Pages for a Zone error codes

                                                                                                                                                                                                                                                                  CodeDescription
                                                                                                                                                                                                                                                                  1000Invalid user
                                                                                                                                                                                                                                                                  1001Invalid request. Could not connect to database
                                                                                                                                                                                                                                                                  1002Validator dispatcher expects an array
                                                                                                                                                                                                                                                                  1004Cannot find a valid zone
                                                                                                                                                                                                                                                                  1006Cannot find a valid customization page
                                                                                                                                                                                                                                                                  1007Invalid validation method being called
                                                                                                                                                                                                                                                                  1200A URL is required
                                                                                                                                                                                                                                                                  1201The URL provided seems to be irregular
                                                                                                                                                                                                                                                                  1202Unable to grab the content for the URL provided. Please try again.
                                                                                                                                                                                                                                                                  1203Your custom page must be larger than <characters> characters
                                                                                                                                                                                                                                                                  1204Your custom page must be smaller than <characters> characters
                                                                                                                                                                                                                                                                  1205A <token> token was not detected on the error page, and must be added before this page can be integrated into Cloudflare. The default error page will show until this is corrected and rescanned.
                                                                                                                                                                                                                                                                  1206Could not find a valid zone
                                                                                                                                                                                                                                                                  1207That customization page is not modifiable
                                                                                                                                                                                                                                                                  1208An unknown error has occurred and has been logged. We will fix this problem promptly. We apologize for the inconvenience.
                                                                                                                                                                                                                                                                  1209Could not find a valid customization page for this operation
                                                                                                                                                                                                                                                                  1210That operation is no longer allowed for that domain.
                                                                                                                                                                                                                                                                  1211Could not find a valid customization page to disable
                                                                                                                                                                                                                                                                  1212An undocumented error has occurred and has been logged.
                                                                                                                                                                                                                                                                  1213That operation has already been performed for this challenge/error.
                                                                                                                                                                                                                                                                  1214Rate limit reached for this operation. Please try again in a minute
                                                                                                                                                                                                                                                                  1215Rate limit reached for this operation. Please try again in a minute
                                                                                                                                                                                                                                                                  1217Invalid state passed
                                                                                                                                                                                                                                                                  1218Missing Custom Page state
                                                                                                                                                                                                                                                                  1219Please upgrade to access this feature
                                                                                                                                                                                                                                                                  1220We were unable to scan the page provided. Please ensure it is accessible publicly and is larger than 100 characters

                                                                                                                                                                                                                                                                  Custom SSL for a Zone

                                                                                                                                                                                                                                                                  Custom SSL certificate for a zone

                                                                                                                                                                                                                                                                  custom-ssl-for-a-zone

                                                                                                                                                                                                                                                                  Object definition

                                                                                                                                                                                                                                                                  View properties and constraints defined on the object

                                                                                                                                                                                                                                                                  Show definition

                                                                                                                                                                                                                                                                  custom-ssl-for-a-zone-list-ssl-configurations

                                                                                                                                                                                                                                                                  GET List SSL Configurations permission needed: #ssl:read
                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                  List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.

                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/custom_certificates

                                                                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                  status

                                                                                                                                                                                                                                                                  Status of the zone's custom SSL

                                                                                                                                                                                                                                                                  "active"
                                                                                                                                                                                                                                                                  • valid values: active, expired, deleted, pending, initializing
                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                  number

                                                                                                                                                                                                                                                                  Page number of paginated results

                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                  number

                                                                                                                                                                                                                                                                  Number of zones per page

                                                                                                                                                                                                                                                                  20
                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                  • max value:50
                                                                                                                                                                                                                                                                  match
                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                  Whether to match all search requirements or at least one (any)

                                                                                                                                                                                                                                                                  "all"
                                                                                                                                                                                                                                                                  • default value: all
                                                                                                                                                                                                                                                                  • valid values: any, all
                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates?status=active&page=1&per_page=20&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
      "hosts": [
        "example.com"
      ],
      "issuer": "GlobalSign",
      "signature": "SHA256WithRSA",
      "status": "active",
      "bundle_method": "ubiquitous",
      "geo_restrictions": {
        "label": "us"
      },
      "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "uploaded_on": "2014-01-01T05:20:00Z",
      "modified_on": "2014-01-01T05:20:00Z",
      "expires_on": "2016-01-01T05:20:00Z",
      "priority": 1
    }
  ]
}
                                                                                                                                                                                                                                                                  custom-ssl-for-a-zone-create-ssl-configuration

                                                                                                                                                                                                                                                                  POST Create SSL Configuration permission needed: #ssl:edit
                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                  Upload a new SSL certificate for a zone

                                                                                                                                                                                                                                                                  POST zones/:zone_identifier/custom_certificates

                                                                                                                                                                                                                                                                  Required parameters

                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                  certificate
                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                  The zone's SSL certificate or certificate and the intermediate(s)

                                                                                                                                                                                                                                                                  "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"
                                                                                                                                                                                                                                                                    private_key
                                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                                    The zone's private key

                                                                                                                                                                                                                                                                    "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"

                                                                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                      bundle_method
                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                      A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.

                                                                                                                                                                                                                                                                      "ubiquitous"
                                                                                                                                                                                                                                                                      • default value: ubiquitous
                                                                                                                                                                                                                                                                      • valid values: ubiquitous, optimal, force
                                                                                                                                                                                                                                                                      geo_restrictions
                                                                                                                                                                                                                                                                      object

                                                                                                                                                                                                                                                                      Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.

                                                                                                                                                                                                                                                                      { "label": "us" }
                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                        type
                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                        The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.

                                                                                                                                                                                                                                                                        "sni_custom"
                                                                                                                                                                                                                                                                        • default value: legacy_custom
                                                                                                                                                                                                                                                                        • valid values: legacy_custom, sni_custom
                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","bundle_method":"ubiquitous","geo_restrictions":{"label":"us"},"type":"sni_custom"}'
                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "hosts": [
      "example.com"
    ],
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "status": "active",
    "bundle_method": "ubiquitous",
    "geo_restrictions": {
      "label": "us"
    },
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "uploaded_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z",
    "expires_on": "2016-01-01T05:20:00Z",
    "priority": 1
  }
}
                                                                                                                                                                                                                                                                        custom-ssl-for-a-zone-ssl-configuration-details

                                                                                                                                                                                                                                                                        GET SSL Configuration Details permission needed: #ssl:read
                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/custom_certificates/:identifier
                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "hosts": [
      "example.com"
    ],
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "status": "active",
    "bundle_method": "ubiquitous",
    "geo_restrictions": {
      "label": "us"
    },
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "uploaded_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z",
    "expires_on": "2016-01-01T05:20:00Z",
    "priority": 1
  }
}
                                                                                                                                                                                                                                                                        custom-ssl-for-a-zone-edit-ssl-configuration

                                                                                                                                                                                                                                                                        PATCH Edit SSL Configuration permission needed: #ssl:edit
                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                        Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.

                                                                                                                                                                                                                                                                        PATCH zones/:zone_identifier/custom_certificates/:identifier

                                                                                                                                                                                                                                                                        Optional parameters

                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                        private_key
                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                        The zone's private key

                                                                                                                                                                                                                                                                        "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
                                                                                                                                                                                                                                                                          certificate
                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                          The zone's SSL certificate or certificate and the intermediate(s)

                                                                                                                                                                                                                                                                          "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"
                                                                                                                                                                                                                                                                            bundle_method
                                                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                                                            A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.

                                                                                                                                                                                                                                                                            "ubiquitous"
                                                                                                                                                                                                                                                                            • default value: ubiquitous
                                                                                                                                                                                                                                                                            • valid values: ubiquitous, optimal, force
                                                                                                                                                                                                                                                                            geo_restrictions
                                                                                                                                                                                                                                                                            object

                                                                                                                                                                                                                                                                            Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.

                                                                                                                                                                                                                                                                            { "label": "us" }
                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                              curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","bundle_method":"ubiquitous","geo_restrictions":{"label":"us"}}'
                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "hosts": [
      "example.com"
    ],
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "status": "active",
    "bundle_method": "ubiquitous",
    "geo_restrictions": {
      "label": "us"
    },
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "uploaded_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z",
    "expires_on": "2016-01-01T05:20:00Z",
    "priority": 1
  }
}
                                                                                                                                                                                                                                                                              custom-ssl-for-a-zone-delete-ssl-configuration

                                                                                                                                                                                                                                                                              DELETE Delete SSL Configuration permission needed: #ssl:edit
                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                                                              Remove a SSL certificate from a zone.

                                                                                                                                                                                                                                                                              DELETE zones/:zone_identifier/custom_certificates/:identifier
                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                              curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60"
  }
}
                                                                                                                                                                                                                                                                              custom-ssl-for-a-zone-re-prioritize-ssl-certificates

                                                                                                                                                                                                                                                                              PUT Re-prioritize SSL Certificates permission needed: #ssl:edit
                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                                                              If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.

                                                                                                                                                                                                                                                                              PUT zones/:zone_identifier/custom_certificates/prioritize

                                                                                                                                                                                                                                                                              Required parameters

                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                              certificates
                                                                                                                                                                                                                                                                              array

                                                                                                                                                                                                                                                                              Array of ordered certificates.

                                                                                                                                                                                                                                                                              [ { "id": "5a7805061c76ada191ed06f989cc3dac", "priority": 2 }, { "id": "9a7806061c88ada191ed06f989cc3dac", "priority": 1 } ]
                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_certificates/prioritize" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"certificates":[{"id":"5a7805061c76ada191ed06f989cc3dac","priority":2},{"id":"9a7806061c88ada191ed06f989cc3dac","priority":1}]}'
                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
      "hosts": [
        "example.com"
      ],
      "issuer": "GlobalSign",
      "signature": "SHA256WithRSA",
      "status": "active",
      "bundle_method": "ubiquitous",
      "geo_restrictions": {
        "label": "us"
      },
      "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "uploaded_on": "2014-01-01T05:20:00Z",
      "modified_on": "2014-01-01T05:20:00Z",
      "expires_on": "2016-01-01T05:20:00Z",
      "priority": 1
    }
  ]
}

                                                                                                                                                                                                                                                                                Custom Hostname for a Zone

                                                                                                                                                                                                                                                                                Manage hostnames for your zone that are routed via CNAME.

                                                                                                                                                                                                                                                                                custom-hostname-for-a-zone

                                                                                                                                                                                                                                                                                Object definition

                                                                                                                                                                                                                                                                                View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                Show definition

                                                                                                                                                                                                                                                                                custom-hostname-for-a-zone-list-custom-hostnames

                                                                                                                                                                                                                                                                                GET List Custom Hostnames permission needed: #ssl:read
                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                List, search, sort, and filter all of your custom hostnames

                                                                                                                                                                                                                                                                                GET zones/:zone_identifier/custom_hostnames

                                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                hostname
                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.

                                                                                                                                                                                                                                                                                "app.example.com"
                                                                                                                                                                                                                                                                                • max length: 255
                                                                                                                                                                                                                                                                                id
                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.

                                                                                                                                                                                                                                                                                "0d89c70d-ad9f-4843-b99f-6cc0252067e9"
                                                                                                                                                                                                                                                                                • min length: 36
                                                                                                                                                                                                                                                                                • max length: 36
                                                                                                                                                                                                                                                                                page
                                                                                                                                                                                                                                                                                number

                                                                                                                                                                                                                                                                                Page number of paginated results

                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                • default value: 1
                                                                                                                                                                                                                                                                                • min value:1
                                                                                                                                                                                                                                                                                per_page
                                                                                                                                                                                                                                                                                number

                                                                                                                                                                                                                                                                                Number of hostnames per page

                                                                                                                                                                                                                                                                                20
                                                                                                                                                                                                                                                                                • default value: 20
                                                                                                                                                                                                                                                                                • min value:5
                                                                                                                                                                                                                                                                                • max value:50
                                                                                                                                                                                                                                                                                order

                                                                                                                                                                                                                                                                                Field to order hostnames by

                                                                                                                                                                                                                                                                                "ssl"
                                                                                                                                                                                                                                                                                • default value: ssl
                                                                                                                                                                                                                                                                                • valid values: ssl, ssl_status
                                                                                                                                                                                                                                                                                direction

                                                                                                                                                                                                                                                                                Direction to order hostnames

                                                                                                                                                                                                                                                                                "desc"
                                                                                                                                                                                                                                                                                • valid values: asc, desc
                                                                                                                                                                                                                                                                                ssl

                                                                                                                                                                                                                                                                                Whether to filter hostnames based on if they have SSL enabled

                                                                                                                                                                                                                                                                                "0"
                                                                                                                                                                                                                                                                                • default value: 0
                                                                                                                                                                                                                                                                                • valid values: 0, 1
                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames?hostname=app.example.com&id=0d89c70d-ad9f-4843-b99f-6cc0252067e9&page=1&per_page=20&order=ssl&direction=desc&ssl=0" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "hostname": "app.example.com",
      "ssl": {
        "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
        "status": "pending_validation",
        "method": "http",
        "type": "dv",
        "txt_name": "_acme-challenge.app.example.com",
        "txt_value": "810b7d5f01154524b961ba0cd578acc2",
        "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
        "http_body": "ca3-574923932a82475cb8592200f1a2a23d",
        "emails": [
          "administrator@example.com",
          "webmaster@example.com"
        ],
        "validation_errors": [
          {
            "message": "SERVFAIL looking up CAA for app.example.com"
          }
        ],
        "hosts": [
          "app.example.com",
          "*.app.example.com"
        ],
        "issuer": "DigiCertInc",
        "serial_number": "6743787633689793699141714808227354901",
        "signature": "SHA256WithRSA",
        "uploaded_on": "2020-02-06T18:11:23.531995Z",
        "expires_on": "2021-02-06T18:11:23.531995Z",
        "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
        "settings": {
          "http2": "on",
          "http3": "on",
          "min_tls_version": "1.2",
          "tls_1_3": "on",
          "ciphers": [
            "ECDHE-RSA-AES128-GCM-SHA256",
            "AES128-SHA"
          ]
        },
        "bundle_method": "ubiquitous",
        "wildcard": false,
        "certificate_authority": "digicert",
        "custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
        "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
      },
      "custom_metadata": {
        "key": "value"
      },
      "custom_origin_server": "origin2.example.com",
      "status": "pending",
      "verification_errors": [
        "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
      ],
      "ownership_verification": {
        "type": "txt",
        "name": "_cf-custom-hostname.app.example.com",
        "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
      },
      "ownership_verification_http": {
        "http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
        "http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
      },
      "created_at": "2020-02-06T18:11:23.531995Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                custom-hostname-for-a-zone-create-custom-hostname

                                                                                                                                                                                                                                                                                POST Create Custom Hostname permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).

                                                                                                                                                                                                                                                                                POST zones/:zone_identifier/custom_hostnames

                                                                                                                                                                                                                                                                                Required parameters

                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                hostname
                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                The custom hostname that will point to your hostname via CNAME.

                                                                                                                                                                                                                                                                                "app.example.com"
                                                                                                                                                                                                                                                                                • max length: 255
                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                ssl
                                                                                                                                                                                                                                                                                object

                                                                                                                                                                                                                                                                                SSL properties used when creating the custom hostname

                                                                                                                                                                                                                                                                                { "method": "http", "type": "dv", "settings": { "http2": "on", "http3": "on", "min_tls_version": "1.2", "tls_1_3": "on", "ciphers": [ "ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA" ] }, "bundle_method": "ubiquitous", "wildcard": false, "custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n", "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n" }
                                                                                                                                                                                                                                                                                One of the following:
                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"hostname":"app.example.com","ssl":{"method":"http","type":"dv","settings":{"http2":"on","http3":"on","min_tls_version":"1.2","tls_1_3":"on","ciphers":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]},"bundle_method":"ubiquitous","wildcard":false,"custom_certificate":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","custom_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"}}'
                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "hostname": "app.example.com",
    "ssl": {
      "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "status": "pending_validation",
      "method": "http",
      "type": "dv",
      "txt_name": "_acme-challenge.app.example.com",
      "txt_value": "810b7d5f01154524b961ba0cd578acc2",
      "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
      "http_body": "ca3-574923932a82475cb8592200f1a2a23d",
      "emails": [
        "administrator@example.com",
        "webmaster@example.com"
      ],
      "validation_errors": [
        {
          "message": "SERVFAIL looking up CAA for app.example.com"
        }
      ],
      "hosts": [
        "app.example.com",
        "*.app.example.com"
      ],
      "issuer": "DigiCertInc",
      "serial_number": "6743787633689793699141714808227354901",
      "signature": "SHA256WithRSA",
      "uploaded_on": "2020-02-06T18:11:23.531995Z",
      "expires_on": "2021-02-06T18:11:23.531995Z",
      "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
      "settings": {
        "http2": "on",
        "http3": "on",
        "min_tls_version": "1.2",
        "tls_1_3": "on",
        "ciphers": [
          "ECDHE-RSA-AES128-GCM-SHA256",
          "AES128-SHA"
        ]
      },
      "bundle_method": "ubiquitous",
      "wildcard": false,
      "certificate_authority": "digicert",
      "custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
      "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
    },
    "custom_metadata": {
      "key": "value"
    },
    "custom_origin_server": "origin2.example.com",
    "status": "pending",
    "verification_errors": [
      "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
    ],
    "ownership_verification": {
      "type": "txt",
      "name": "_cf-custom-hostname.app.example.com",
      "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
    },
    "ownership_verification_http": {
      "http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
    },
    "created_at": "2020-02-06T18:11:23.531995Z"
  }
}
                                                                                                                                                                                                                                                                                  custom-hostname-for-a-zone-custom-hostname-details

                                                                                                                                                                                                                                                                                  GET Custom Hostname Details permission needed: #ssl:read
                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/custom_hostnames/:identifier
                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/0d89c70d-ad9f-4843-b99f-6cc0252067e9" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "hostname": "app.example.com",
    "ssl": {
      "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "status": "pending_validation",
      "method": "http",
      "type": "dv",
      "txt_name": "_acme-challenge.app.example.com",
      "txt_value": "810b7d5f01154524b961ba0cd578acc2",
      "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
      "http_body": "ca3-574923932a82475cb8592200f1a2a23d",
      "emails": [
        "administrator@example.com",
        "webmaster@example.com"
      ],
      "validation_errors": [
        {
          "message": "SERVFAIL looking up CAA for app.example.com"
        }
      ],
      "hosts": [
        "app.example.com",
        "*.app.example.com"
      ],
      "issuer": "DigiCertInc",
      "serial_number": "6743787633689793699141714808227354901",
      "signature": "SHA256WithRSA",
      "uploaded_on": "2020-02-06T18:11:23.531995Z",
      "expires_on": "2021-02-06T18:11:23.531995Z",
      "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
      "settings": {
        "http2": "on",
        "http3": "on",
        "min_tls_version": "1.2",
        "tls_1_3": "on",
        "ciphers": [
          "ECDHE-RSA-AES128-GCM-SHA256",
          "AES128-SHA"
        ]
      },
      "bundle_method": "ubiquitous",
      "wildcard": false,
      "certificate_authority": "digicert",
      "custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
      "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
    },
    "custom_metadata": {
      "key": "value"
    },
    "custom_origin_server": "origin2.example.com",
    "status": "pending",
    "verification_errors": [
      "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
    ],
    "ownership_verification": {
      "type": "txt",
      "name": "_cf-custom-hostname.app.example.com",
      "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
    },
    "ownership_verification_http": {
      "http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
    },
    "created_at": "2020-02-06T18:11:23.531995Z"
  }
}
                                                                                                                                                                                                                                                                                  custom-hostname-for-a-zone-edit-custom-hostname

                                                                                                                                                                                                                                                                                  PATCH Edit Custom Hostname permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                  • enterprise

                                                                                                                                                                                                                                                                                  Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'.

                                                                                                                                                                                                                                                                                  PATCH zones/:zone_identifier/custom_hostnames/:identifier

                                                                                                                                                                                                                                                                                  Optional parameters

                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                  ssl
                                                                                                                                                                                                                                                                                  object

                                                                                                                                                                                                                                                                                  SSL properties used when creating the custom hostname

                                                                                                                                                                                                                                                                                  { "method": "http", "type": "dv", "settings": { "http2": "on", "http3": "on", "min_tls_version": "1.2", "tls_1_3": "on", "ciphers": [ "ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA" ] }, "bundle_method": "ubiquitous", "wildcard": false, "custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n", "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n" }
                                                                                                                                                                                                                                                                                  One of the following:
                                                                                                                                                                                                                                                                                    custom_metadata
                                                                                                                                                                                                                                                                                    object

                                                                                                                                                                                                                                                                                    These are per-hostname (customer) settings.

                                                                                                                                                                                                                                                                                    { "key": "value" }
                                                                                                                                                                                                                                                                                    Any of the following:
                                                                                                                                                                                                                                                                                      custom_origin_server
                                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                                      a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

                                                                                                                                                                                                                                                                                      "origin2.example.com"
                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                        curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/0d89c70d-ad9f-4843-b99f-6cc0252067e9" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"ssl":{"method":"http","type":"dv","settings":{"http2":"on","http3":"on","min_tls_version":"1.2","tls_1_3":"on","ciphers":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"]},"bundle_method":"ubiquitous","wildcard":false,"custom_certificate":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","custom_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"},"custom_metadata":{"key":"value"},"custom_origin_server":"origin2.example.com"}'
                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "hostname": "app.example.com",
    "ssl": {
      "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "status": "pending_validation",
      "method": "http",
      "type": "dv",
      "txt_name": "_acme-challenge.app.example.com",
      "txt_value": "810b7d5f01154524b961ba0cd578acc2",
      "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt",
      "http_body": "ca3-574923932a82475cb8592200f1a2a23d",
      "emails": [
        "administrator@example.com",
        "webmaster@example.com"
      ],
      "validation_errors": [
        {
          "message": "SERVFAIL looking up CAA for app.example.com"
        }
      ],
      "hosts": [
        "app.example.com",
        "*.app.example.com"
      ],
      "issuer": "DigiCertInc",
      "serial_number": "6743787633689793699141714808227354901",
      "signature": "SHA256WithRSA",
      "uploaded_on": "2020-02-06T18:11:23.531995Z",
      "expires_on": "2021-02-06T18:11:23.531995Z",
      "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
      "settings": {
        "http2": "on",
        "http3": "on",
        "min_tls_version": "1.2",
        "tls_1_3": "on",
        "ciphers": [
          "ECDHE-RSA-AES128-GCM-SHA256",
          "AES128-SHA"
        ]
      },
      "bundle_method": "ubiquitous",
      "wildcard": false,
      "certificate_authority": "digicert",
      "custom_certificate": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
      "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
    },
    "custom_metadata": {
      "key": "value"
    },
    "custom_origin_server": "origin2.example.com",
    "status": "pending",
    "verification_errors": [
      "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."
    ],
    "ownership_verification": {
      "type": "txt",
      "name": "_cf-custom-hostname.app.example.com",
      "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
    },
    "ownership_verification_http": {
      "http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9",
      "http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4"
    },
    "created_at": "2020-02-06T18:11:23.531995Z"
  }
}
                                                                                                                                                                                                                                                                                        custom-hostname-for-a-zone-delete-custom-hostname-and-any-issued-ssl-certificates-

                                                                                                                                                                                                                                                                                        DELETE Delete Custom Hostname (and any issued SSL certificates) permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                        DELETE zones/:zone_identifier/custom_hostnames/:identifier
                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/0d89c70d-ad9f-4843-b99f-6cc0252067e9" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                        {
  "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9"
}

                                                                                                                                                                                                                                                                                        Custom Hostname Fallback Origin for a Zone

                                                                                                                                                                                                                                                                                        Setup Fallback Origin for all Custom Hostnames for your zone.

                                                                                                                                                                                                                                                                                        custom-hostname-fallback-origin-for-a-zone

                                                                                                                                                                                                                                                                                        Object definition

                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                        Show definition

                                                                                                                                                                                                                                                                                        custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames

                                                                                                                                                                                                                                                                                        GET Get Fallback Origin for Custom Hostnames permission needed: #ssl:read
                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/custom_hostnames/fallback_origin
                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/fallback_origin" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "origin": "fallback.example.com",
    "status": "pending_deployment",
    "errors": [
      "DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"
    ],
    "created_at": "2019-10-28T18:11:23.37411Z",
    "updated_at": "2020-03-16T18:11:23.531995Z"
  }
}
                                                                                                                                                                                                                                                                                        custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames

                                                                                                                                                                                                                                                                                        PUT Update Fallback Origin for Custom Hostnames permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                        PUT zones/:zone_identifier/custom_hostnames/fallback_origin

                                                                                                                                                                                                                                                                                        Required parameters

                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                        origin
                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                        Your origin hostname that requests to your custom hostnames will be sent to.

                                                                                                                                                                                                                                                                                        "fallback.example.com"
                                                                                                                                                                                                                                                                                        • max length: 255
                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/fallback_origin" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"origin":"fallback.example.com"}'
                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "origin": "fallback.example.com",
    "status": "pending_deployment",
    "errors": [
      "DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"
    ],
    "created_at": "2019-10-28T18:11:23.37411Z",
    "updated_at": "2020-03-16T18:11:23.531995Z"
  }
}
                                                                                                                                                                                                                                                                                        custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames

                                                                                                                                                                                                                                                                                        DELETE Delete Fallback Origin for Custom Hostnames permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                        DELETE zones/:zone_identifier/custom_hostnames/fallback_origin
                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/custom_hostnames/fallback_origin" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "origin": "fallback.example.com",
    "status": "pending_deployment",
    "errors": [
      "DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"
    ],
    "created_at": "2019-10-28T18:11:23.37411Z",
    "updated_at": "2020-03-16T18:11:23.531995Z"
  }
}

                                                                                                                                                                                                                                                                                        Keyless SSL for a Zone

                                                                                                                                                                                                                                                                                        A Keyless certificate is an SSL certificate where the SSL private key is not stored on Cloudflare

                                                                                                                                                                                                                                                                                        keyless-ssl-for-a-zone

                                                                                                                                                                                                                                                                                        Object definition

                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                        Show definition

                                                                                                                                                                                                                                                                                        keyless-ssl-for-a-zone-list-keyless-ssl-configurations

                                                                                                                                                                                                                                                                                        GET List Keyless SSL Configurations permission needed: #ssl:read
                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                        List all Keyless SSL configurations for a given zone

                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/keyless_certificates
                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "4d2844d2ce78891c34d0b6c0535a291e",
      "name": "example.com Keyless SSL",
      "host": "example.com",
      "port": 24008,
      "status": "active",
      "enabled": false,
      "permissions": [
        "#ssl:read",
        "#ssl:edit"
      ],
      "created_on": "2014-01-01T05:20:00Z",
      "modified_on": "2014-01-01T05:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                        keyless-ssl-for-a-zone-create-keyless-ssl-configuration

                                                                                                                                                                                                                                                                                        POST Create Keyless SSL Configuration permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                        POST zones/:zone_identifier/keyless_certificates

                                                                                                                                                                                                                                                                                        Required parameters

                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                        host
                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                        The keyless SSL name

                                                                                                                                                                                                                                                                                        "example.com"
                                                                                                                                                                                                                                                                                        • max length: 253
                                                                                                                                                                                                                                                                                        • pattern: hostname_or_ip
                                                                                                                                                                                                                                                                                        port
                                                                                                                                                                                                                                                                                        number

                                                                                                                                                                                                                                                                                        The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server

                                                                                                                                                                                                                                                                                        24008
                                                                                                                                                                                                                                                                                        • default value: 24008
                                                                                                                                                                                                                                                                                        • max length: 65535
                                                                                                                                                                                                                                                                                        certificate
                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                        The zone's SSL certificate or SSL certificate and intermediate(s)

                                                                                                                                                                                                                                                                                        "-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----"

                                                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                          The keyless SSL name

                                                                                                                                                                                                                                                                                          "example.com Keyless SSL"
                                                                                                                                                                                                                                                                                          • max length: 180
                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                          bundle_method
                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                          A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.

                                                                                                                                                                                                                                                                                          "ubiquitous"
                                                                                                                                                                                                                                                                                          • default value: ubiquitous
                                                                                                                                                                                                                                                                                          • valid values: ubiquitous, optimal, force
                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"host":"example.com","port":24008,"name":"example.com Keyless SSL","certificate":"-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----","bundle_method":"ubiquitous"}'
                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4d2844d2ce78891c34d0b6c0535a291e",
    "name": "example.com Keyless SSL",
    "host": "example.com",
    "port": 24008,
    "status": "active",
    "enabled": false,
    "permissions": [
      "#ssl:read",
      "#ssl:edit"
    ],
    "created_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                          keyless-ssl-for-a-zone-get-keyless-ssl-configuration

                                                                                                                                                                                                                                                                                          GET Get Keyless SSL Configuration permission needed: #ssl:read
                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                          • enterprise

                                                                                                                                                                                                                                                                                          Get details for one Keyless SSL configuration

                                                                                                                                                                                                                                                                                          GET zones/:zone_identifier/keyless_certificates/:identifier
                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates/4d2844d2ce78891c34d0b6c0535a291e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4d2844d2ce78891c34d0b6c0535a291e",
    "name": "example.com Keyless SSL",
    "host": "example.com",
    "port": 24008,
    "status": "active",
    "enabled": false,
    "permissions": [
      "#ssl:read",
      "#ssl:edit"
    ],
    "created_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                          keyless-ssl-for-a-zone-edit-keyless-ssl-configuration

                                                                                                                                                                                                                                                                                          PATCH Edit Keyless SSL Configuration permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                          • enterprise

                                                                                                                                                                                                                                                                                          This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port,certificate,enabled

                                                                                                                                                                                                                                                                                          PATCH zones/:zone_identifier/keyless_certificates/:identifier

                                                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                          host
                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                          The keyless SSL name

                                                                                                                                                                                                                                                                                          "example.com"
                                                                                                                                                                                                                                                                                          • max length: 253
                                                                                                                                                                                                                                                                                          • pattern: hostname_or_ip
                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                          The keyless SSL name

                                                                                                                                                                                                                                                                                          "example.com Keyless SSL"
                                                                                                                                                                                                                                                                                          • max length: 180
                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                          port
                                                                                                                                                                                                                                                                                          number

                                                                                                                                                                                                                                                                                          The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server

                                                                                                                                                                                                                                                                                          24008
                                                                                                                                                                                                                                                                                          • default value: 24008
                                                                                                                                                                                                                                                                                          • max length: 65535
                                                                                                                                                                                                                                                                                          enabled
                                                                                                                                                                                                                                                                                          boolean

                                                                                                                                                                                                                                                                                          Whether or not the Keyless SSL is on or off

                                                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                          curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates/4d2844d2ce78891c34d0b6c0535a291e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"host":"example.com","name":"example.com Keyless SSL","port":24008,"enabled":false}'
                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4d2844d2ce78891c34d0b6c0535a291e",
    "name": "example.com Keyless SSL",
    "host": "example.com",
    "port": 24008,
    "status": "active",
    "enabled": false,
    "permissions": [
      "#ssl:read",
      "#ssl:edit"
    ],
    "created_on": "2014-01-01T05:20:00Z",
    "modified_on": "2014-01-01T05:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                          keyless-ssl-for-a-zone-delete-keyless-ssl-configuration

                                                                                                                                                                                                                                                                                          DELETE Delete Keyless SSL Configuration permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                          • enterprise

                                                                                                                                                                                                                                                                                          DELETE zones/:zone_identifier/keyless_certificates/:identifier
                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/keyless_certificates/4d2844d2ce78891c34d0b6c0535a291e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4d2844d2ce78891c34d0b6c0535a291e"
  }
}

                                                                                                                                                                                                                                                                                          Analyze Certificate

                                                                                                                                                                                                                                                                                          analyze-certificate

                                                                                                                                                                                                                                                                                          Object definition

                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                          Show definition

                                                                                                                                                                                                                                                                                          analyze-certificate-analyze-certificate

                                                                                                                                                                                                                                                                                          POST Analyze Certificate permission needed: #ssl:read
                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                          • enterprise

                                                                                                                                                                                                                                                                                          Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.

                                                                                                                                                                                                                                                                                          POST zones/:identifier/ssl/analyze

                                                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                          certificate
                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                          The zone's SSL certificate or certificate and the intermediate(s)

                                                                                                                                                                                                                                                                                          "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"
                                                                                                                                                                                                                                                                                            bundle_method
                                                                                                                                                                                                                                                                                            string

                                                                                                                                                                                                                                                                                            A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.

                                                                                                                                                                                                                                                                                            "ubiquitous"
                                                                                                                                                                                                                                                                                            • default value: ubiquitous
                                                                                                                                                                                                                                                                                            • valid values: ubiquitous, optimal, force
                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/analyze" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","bundle_method":"ubiquitous"}'
                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "hosts": [
      "example.com"
    ],
    "signature_algorithm": "SHA256WithRSA",
    "expires_on": "2016-01-01T05:20:00Z"
  }
}

                                                                                                                                                                                                                                                                                            Certificate Packs

                                                                                                                                                                                                                                                                                            certificate-packs

                                                                                                                                                                                                                                                                                            Object definition

                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                            Show definition

                                                                                                                                                                                                                                                                                            certificate-packs-list-certificate-packs

                                                                                                                                                                                                                                                                                            GET List Certificate Packs permission needed: #ssl:read
                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                            For a given zone, list all active certificate packs

                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/ssl/certificate_packs

                                                                                                                                                                                                                                                                                            Optional parameters

                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                            status

                                                                                                                                                                                                                                                                                            Include Certificate Packs of all statuses, not just active ones.

                                                                                                                                                                                                                                                                                            "all"
                                                                                                                                                                                                                                                                                            • valid values: all
                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs?status=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "3822ff90-ea29-44df-9e55-21300bb9419b",
      "type": "custom",
      "hosts": [
        "example.com",
        "*.example.com",
        "www.example.com"
      ],
      "certificates": [
        {
          "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
          "hosts": [
            "example.com"
          ],
          "issuer": "GlobalSign",
          "signature": "SHA256WithRSA",
          "status": "active",
          "bundle_method": "ubiquitous",
          "geo_restrictions": {
            "label": "us"
          },
          "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
          "uploaded_on": "2014-01-01T05:20:00Z",
          "modified_on": "2014-01-01T05:20:00Z",
          "expires_on": "2016-01-01T05:20:00Z",
          "priority": 1
        }
      ],
      "primary_certificate": "7e7b8deba8538af625850b7b2530034c"
    }
  ]
}
                                                                                                                                                                                                                                                                                            certificate-packs-get-certificate-pack

                                                                                                                                                                                                                                                                                            GET Get Certificate Pack permission needed: #ssl:read
                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                            For a given zone, get a certificate pack

                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/ssl/certificate_packs/:identifier
                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/3822ff90-ea29-44df-9e55-21300bb9419b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "type": "custom",
    "hosts": [
      "example.com",
      "*.example.com",
      "www.example.com"
    ],
    "certificates": [
      {
        "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
        "hosts": [
          "example.com"
        ],
        "issuer": "GlobalSign",
        "signature": "SHA256WithRSA",
        "status": "active",
        "bundle_method": "ubiquitous",
        "geo_restrictions": {
          "label": "us"
        },
        "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "uploaded_on": "2014-01-01T05:20:00Z",
        "modified_on": "2014-01-01T05:20:00Z",
        "expires_on": "2016-01-01T05:20:00Z",
        "priority": 1
      }
    ],
    "primary_certificate": "7e7b8deba8538af625850b7b2530034c"
  }
}
                                                                                                                                                                                                                                                                                            certificate-packs-get-certificate-pack-quotas

                                                                                                                                                                                                                                                                                            GET Get Certificate Pack Quotas permission needed: #ssl:read
                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                            For a given zone, list certificate pack quotas

                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/ssl/certificate_packs/quota
                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/quota" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "advanced": {
      "allocated": 100,
      "used": 5
    }
  }
}
                                                                                                                                                                                                                                                                                            certificate-packs-order-certificate-pack

                                                                                                                                                                                                                                                                                            POST Order Certificate Pack permission needed: #ssl:read#ssl:edit
                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                            For a given zone, order a certificate pack with a list of hostnames

                                                                                                                                                                                                                                                                                            POST zones/:zone_identifier/ssl/certificate_packs

                                                                                                                                                                                                                                                                                            Optional parameters

                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                            hosts
                                                                                                                                                                                                                                                                                            array

                                                                                                                                                                                                                                                                                            Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.

                                                                                                                                                                                                                                                                                            [ "example.com", "*.example.com", "www.example.com" ]
                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"hosts":["example.com","*.example.com","www.example.com"]}'
                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "type": "custom",
    "hosts": [
      "example.com",
      "*.example.com",
      "www.example.com"
    ],
    "certificates": [
      {
        "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
        "hosts": [
          "example.com"
        ],
        "issuer": "GlobalSign",
        "signature": "SHA256WithRSA",
        "status": "active",
        "bundle_method": "ubiquitous",
        "geo_restrictions": {
          "label": "us"
        },
        "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "uploaded_on": "2014-01-01T05:20:00Z",
        "modified_on": "2014-01-01T05:20:00Z",
        "expires_on": "2016-01-01T05:20:00Z",
        "priority": 1
      }
    ],
    "primary_certificate": "7e7b8deba8538af625850b7b2530034c"
  }
}
                                                                                                                                                                                                                                                                                              certificate-packs-order-advanced-certificate-manager-certificate-pack

                                                                                                                                                                                                                                                                                              POST Order Advanced Certificate Manager Certificate Pack permission needed: #ssl:read#ssl:edit
                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                                                                              For a given zone, order an advanced certificate pack

                                                                                                                                                                                                                                                                                              POST zones/:zone_identifier/ssl/certificate_packs/order

                                                                                                                                                                                                                                                                                              Required parameters

                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                              type
                                                                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                                                                              Type of certificate pack

                                                                                                                                                                                                                                                                                              "advanced"
                                                                                                                                                                                                                                                                                              • valid values: advanced
                                                                                                                                                                                                                                                                                              hosts
                                                                                                                                                                                                                                                                                              array

                                                                                                                                                                                                                                                                                              Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.

                                                                                                                                                                                                                                                                                              [ "example.com", "*.example.com", "www.example.com" ]
                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                validation_method
                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                Validation Method selected for the order

                                                                                                                                                                                                                                                                                                "txt"
                                                                                                                                                                                                                                                                                                • valid values: txt, http, email
                                                                                                                                                                                                                                                                                                validity_days
                                                                                                                                                                                                                                                                                                integer

                                                                                                                                                                                                                                                                                                Validity Days selected for the order

                                                                                                                                                                                                                                                                                                365
                                                                                                                                                                                                                                                                                                • valid values: 14, 30, 90, 365
                                                                                                                                                                                                                                                                                                certificate_authority
                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).

                                                                                                                                                                                                                                                                                                "digicert"
                                                                                                                                                                                                                                                                                                • valid values: digicert, lets_encrypt

                                                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                cloudflare_branding
                                                                                                                                                                                                                                                                                                boolean

                                                                                                                                                                                                                                                                                                Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true

                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/order" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"advanced","hosts":["example.com","*.example.com","www.example.com"],"validation_method":"txt","validity_days":365,"certificate_authority":"digicert","cloudflare_branding":false}'
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "type": "advanced",
    "hosts": [
      "example.com",
      "*.example.com",
      "www.example.com"
    ],
    "status": "initializing",
    "validation_method": "txt",
    "validity_days": 365,
    "certificate_authority": "digicert",
    "cloudflare_branding": false
  }
}
                                                                                                                                                                                                                                                                                                certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack

                                                                                                                                                                                                                                                                                                PATCH Restart Validation for Advanced Certificate Manager Certificate Pack permission needed: #ssl:read#ssl:edit
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status.

                                                                                                                                                                                                                                                                                                PATCH zones/:zone_identifier/ssl/certificate_packs/:identifier
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/3822ff90-ea29-44df-9e55-21300bb9419b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3822ff90-ea29-44df-9e55-21300bb9419b",
    "type": "advanced",
    "hosts": [
      "example.com",
      "*.example.com",
      "www.example.com"
    ],
    "status": "initializing",
    "validation_method": "txt",
    "validity_days": 365,
    "certificate_authority": "digicert",
    "cloudflare_branding": false
  }
}
                                                                                                                                                                                                                                                                                                certificate-packs-delete-advanced-certificate-manager-certificate-pack

                                                                                                                                                                                                                                                                                                DELETE Delete Advanced Certificate Manager Certificate Pack permission needed: #ssl:read#ssl:edit
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                For a given zone, delete an advanced certificate pack

                                                                                                                                                                                                                                                                                                DELETE zones/:zone_identifier/ssl/certificate_packs/:identifier
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/certificate_packs/3822ff90-ea29-44df-9e55-21300bb9419b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "3822ff90-ea29-44df-9e55-21300bb9419b"
  }
}

                                                                                                                                                                                                                                                                                                Certificate Packs error codes

                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                1400Missing required property in request
                                                                                                                                                                                                                                                                                                1401Error while requesting from certificate service
                                                                                                                                                                                                                                                                                                1402Error while requesting from certificate service
                                                                                                                                                                                                                                                                                                1403Bad response certificate service
                                                                                                                                                                                                                                                                                                1404Bad response certificate service
                                                                                                                                                                                                                                                                                                1405Missing required certificate pack id for deletion
                                                                                                                                                                                                                                                                                                1406Bad response certificate service
                                                                                                                                                                                                                                                                                                1407Bad response certificate service
                                                                                                                                                                                                                                                                                                1408ID is not a dedicated or advanced certificate.
                                                                                                                                                                                                                                                                                                1409Error while requesting from certificate service
                                                                                                                                                                                                                                                                                                1410Bad response certificate service
                                                                                                                                                                                                                                                                                                1411ID is not a dedicated or advanced certificate.
                                                                                                                                                                                                                                                                                                1412Missing required property in request
                                                                                                                                                                                                                                                                                                1413You do not have sufficient entitlements to order the Dedicated Certificate. If you recently deleted a Dedicated Certificate it may still be pending removal. Please try again and contact your Customer Success Manager or Cloudflare Support for assistance if the issue persists.
                                                                                                                                                                                                                                                                                                1414You must complete domain control validation (DCV) for all hostnames on the Dedicated Certificate before placing an order.

                                                                                                                                                                                                                                                                                                SSL/TLS Mode Recommendation

                                                                                                                                                                                                                                                                                                SSL/TLS Recommendation for a zone

                                                                                                                                                                                                                                                                                                ssl/tls-mode-recommendation

                                                                                                                                                                                                                                                                                                Object definition

                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                Show definition

                                                                                                                                                                                                                                                                                                ssl/tls-mode-recommendation-ssl/tls-recommendation

                                                                                                                                                                                                                                                                                                GET SSL/TLS Recommendation permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                Retrieve the SSL/TLS Recommender's recommendation for a zone

                                                                                                                                                                                                                                                                                                GET zones/:zone_identifier/ssl/recommendation
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/recommendation" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ssl_recommendation",
    "value": "strict",
    "modified_on": "2014-01-01T05:20:00.12345Z"
  }
}

                                                                                                                                                                                                                                                                                                SSL Verification

                                                                                                                                                                                                                                                                                                SSL Verification for a Zone

                                                                                                                                                                                                                                                                                                ssl-verification

                                                                                                                                                                                                                                                                                                Object definition

                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                Show definition

                                                                                                                                                                                                                                                                                                ssl-verification-ssl-verification-details

                                                                                                                                                                                                                                                                                                GET SSL Verification Details permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                Get SSL Verification Info for a Zone

                                                                                                                                                                                                                                                                                                GET zones/:zone_identifier/ssl/verification

                                                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                retry

                                                                                                                                                                                                                                                                                                Immediately retry SSL Verification

                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                • valid values: true
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/verification?retry=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "result": [
    {
      "certificate_status": "active",
      "verification_type": "cname",
      "verification_status": true,
      "verification_info": {
        "record_name": "b3b90cfedd89a3e487d3e383c56c4267.example.com",
        "record_target": "6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com"
      },
      "brand_check": false,
      "validation_method": "txt",
      "cert_pack_uuid": "a77f8bd7-3b47-46b4-a6f1-75cf98109948"
    }
  ]
}
                                                                                                                                                                                                                                                                                                ssl-verification-edit-ssl-certificate-pack-validation-method

                                                                                                                                                                                                                                                                                                PATCH Edit SSL Certificate Pack Validation Method permission needed: #ssl:read#ssl:edit
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.

                                                                                                                                                                                                                                                                                                PATCH zones/:zone_identifier/ssl/verification/:cert_pack_uuid

                                                                                                                                                                                                                                                                                                Required parameters

                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                validation_method
                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                Desired validation method

                                                                                                                                                                                                                                                                                                "txt"
                                                                                                                                                                                                                                                                                                • valid values: http, cname, txt, email
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/verification/a77f8bd7-3b47-46b4-a6f1-75cf98109948" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"validation_method":"txt"}'
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "validation_method": "txt",
    "status": "pending_validation"
  }
}

                                                                                                                                                                                                                                                                                                Universal SSL Settings for a Zone

                                                                                                                                                                                                                                                                                                Universal SSL Settings for a Zone

                                                                                                                                                                                                                                                                                                universal-ssl-settings-for-a-zone

                                                                                                                                                                                                                                                                                                Object definition

                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                Show definition

                                                                                                                                                                                                                                                                                                universal-ssl-settings-for-a-zone-universal-ssl-settings-details

                                                                                                                                                                                                                                                                                                GET Universal SSL Settings Details permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                Get Universal SSL Settings for a Zone

                                                                                                                                                                                                                                                                                                GET zones/:zone_identifier/ssl/universal/settings
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/universal/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "enabled": true
  }
}
                                                                                                                                                                                                                                                                                                universal-ssl-settings-for-a-zone-edit-universal-ssl-settings

                                                                                                                                                                                                                                                                                                PATCH Edit Universal SSL Settings permission needed: #ssl:read#ssl:edit
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                Patch Universal SSL Settings for a Zone

                                                                                                                                                                                                                                                                                                PATCH zones/:zone_identifier/ssl/universal/settings

                                                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                enabled
                                                                                                                                                                                                                                                                                                boolean

                                                                                                                                                                                                                                                                                                Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no dedicated certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.

                                                                                                                                                                                                                                                                                                By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased a dedicated certificate.

                                                                                                                                                                                                                                                                                                • HSTS
                                                                                                                                                                                                                                                                                                • Always Use HTTPS
                                                                                                                                                                                                                                                                                                • Opportunistic Encryption
                                                                                                                                                                                                                                                                                                • Onion Routing
                                                                                                                                                                                                                                                                                                • Any Page Rules redirecting traffic to HTTPS

                                                                                                                                                                                                                                                                                                Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge.

                                                                                                                                                                                                                                                                                                If you do not have a valid custom or dedicated certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.

                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/ssl/universal/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"enabled":true}'
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "enabled": true
  }
}

                                                                                                                                                                                                                                                                                                Origin CA

                                                                                                                                                                                                                                                                                                API to create Cloudflare-issued SSL certificates that can be installed on your origin server. Use your Origin CA Key as your User Service Key when calling these endpoints (see the section on request headers for details).

                                                                                                                                                                                                                                                                                                origin-ca

                                                                                                                                                                                                                                                                                                Object definition

                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                Show definition

                                                                                                                                                                                                                                                                                                origin-ca-list-certificates

                                                                                                                                                                                                                                                                                                GET List Certificates
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint (see above).

                                                                                                                                                                                                                                                                                                GET certificates

                                                                                                                                                                                                                                                                                                Required parameters

                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                zone_id
                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                Zone identifier tag

                                                                                                                                                                                                                                                                                                "023e105f4ecef8ad9ca31a8372d0c353"
                                                                                                                                                                                                                                                                                                • max length: 32
                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/certificates?zone_id=023e105f4ecef8ad9ca31a8372d0c353" \
     -H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"
                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "328578533902268680212849205732770752308931942346",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----",
      "hostnames": [
        "example.com",
        "*.example.com"
      ],
      "expires_on": "2014-01-01T05:20:00.12345Z",
      "request_type": "origin-rsa",
      "requested_validity": 5475,
      "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
    }
  ]
}
                                                                                                                                                                                                                                                                                                origin-ca-create-certificate

                                                                                                                                                                                                                                                                                                POST Create Certificate
                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                • enterprise

                                                                                                                                                                                                                                                                                                Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint (see above).

                                                                                                                                                                                                                                                                                                POST certificates

                                                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                hostnames
                                                                                                                                                                                                                                                                                                array

                                                                                                                                                                                                                                                                                                Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate

                                                                                                                                                                                                                                                                                                [ "example.com", "*.example.com" ]
                                                                                                                                                                                                                                                                                                  requested_validity
                                                                                                                                                                                                                                                                                                  number

                                                                                                                                                                                                                                                                                                  The number of days for which the certificate should be valid

                                                                                                                                                                                                                                                                                                  5475
                                                                                                                                                                                                                                                                                                  • default value: 5475
                                                                                                                                                                                                                                                                                                  • valid values: 7, 30, 90, 365, 730, 1095, 5475
                                                                                                                                                                                                                                                                                                  request_type
                                                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                                                  Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers)

                                                                                                                                                                                                                                                                                                  "origin-rsa"
                                                                                                                                                                                                                                                                                                  • valid values: origin-rsa, origin-ecc, keyless-certificate
                                                                                                                                                                                                                                                                                                  csr
                                                                                                                                                                                                                                                                                                  string

                                                                                                                                                                                                                                                                                                  The Certificate Signing Request (CSR). Must be newline-encoded.

                                                                                                                                                                                                                                                                                                  "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/certificates" \
     -H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a" \
     --data '{"hostnames":["example.com","*.example.com"],"requested_validity":5475,"request_type":"origin-rsa","csr":"-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"}'
                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "328578533902268680212849205732770752308931942346",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----",
    "hostnames": [
      "example.com",
      "*.example.com"
    ],
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "request_type": "origin-rsa",
    "requested_validity": 5475,
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
  }
}
                                                                                                                                                                                                                                                                                                    origin-ca-get-certificate

                                                                                                                                                                                                                                                                                                    GET Get Certificate
                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                    • enterprise

                                                                                                                                                                                                                                                                                                    Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint (see above).

                                                                                                                                                                                                                                                                                                    GET certificates/:identifier
                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/certificates/328578533902268680212849205732770752308931942346" \
     -H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"
                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "328578533902268680212849205732770752308931942346",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----",
    "hostnames": [
      "example.com",
      "*.example.com"
    ],
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "request_type": "origin-rsa",
    "requested_validity": 5475,
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----"
  }
}
                                                                                                                                                                                                                                                                                                    origin-ca-revoke-certificate

                                                                                                                                                                                                                                                                                                    DELETE Revoke Certificate
                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                    • enterprise

                                                                                                                                                                                                                                                                                                    Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint (see above).

                                                                                                                                                                                                                                                                                                    DELETE certificates/:identifier
                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/certificates/328578533902268680212849205732770752308931942346" \
     -H "X-Auth-User-Service-Key: v1.0-e24fd090c02efcfecb4de8f4ff246fd5c75b48946fdf0ce26c59f91d0d90797b-cfa33fe60e8e34073c149323454383fc9005d25c9b4c502c2f063457ef65322eade065975001a0b4b4c591c5e1bd36a6e8f7e2d4fa8a9ec01c64c041e99530c2-07b9efe0acd78c82c8d9c690aacb8656d81c369246d7f996a205fe3c18e9254a"
                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "328578533902268680212849205732770752308931942346"
  }
}

                                                                                                                                                                                                                                                                                                    Origin CA error codes

                                                                                                                                                                                                                                                                                                    CodeDescription
                                                                                                                                                                                                                                                                                                    1000API errors encountered
                                                                                                                                                                                                                                                                                                    1001Request had no Authorization header
                                                                                                                                                                                                                                                                                                    1002Unsupported request_type
                                                                                                                                                                                                                                                                                                    1003Failed to read contents of HTTP request
                                                                                                                                                                                                                                                                                                    1004Failed to parse request JSON
                                                                                                                                                                                                                                                                                                    1005Too many hostnames requested - you may only request up to 100 per certificate
                                                                                                                                                                                                                                                                                                    1006One or more hostnames were duplicated in the request and have been removed prior to certificate generation
                                                                                                                                                                                                                                                                                                    1007CSR parsed as empty
                                                                                                                                                                                                                                                                                                    1008Error creating request to CA
                                                                                                                                                                                                                                                                                                    1009Permitted values for the 'requested_validity' parameter (specified in days) are: 7, 30, 90, 365, 730, 1095, and 5475 (default)
                                                                                                                                                                                                                                                                                                    1010Failed to validate SAN <hostname>: <reason for failure>
                                                                                                                                                                                                                                                                                                    1011Failed to parse CSR
                                                                                                                                                                                                                                                                                                    1012Please provide a zone id when requesting a stored certificate, or fetch by serial number
                                                                                                                                                                                                                                                                                                    1013Please provide a certificate serial number when operating on a single certificate
                                                                                                                                                                                                                                                                                                    1014Certificate already revoked
                                                                                                                                                                                                                                                                                                    1100Failed to write certificate to database
                                                                                                                                                                                                                                                                                                    1101Failed to read certificate from database
                                                                                                                                                                                                                                                                                                    1200API Error: Failed to generate CA request
                                                                                                                                                                                                                                                                                                    1201CA signing failure. Could not parse returned certificate
                                                                                                                                                                                                                                                                                                    1300Failed to fetch keyless servers from API
                                                                                                                                                                                                                                                                                                    1301key server didn't activate correctly
                                                                                                                                                                                                                                                                                                    1302Could not get keyless server port for server <server>
                                                                                                                                                                                                                                                                                                    1303invalid hostname: <hostname>

                                                                                                                                                                                                                                                                                                    Zone-Level Authenticated Origin Pulls

                                                                                                                                                                                                                                                                                                    Setup authenticated origin pulls for your zone.

                                                                                                                                                                                                                                                                                                    zone-level-authenticated-origin-pulls

                                                                                                                                                                                                                                                                                                    Object definition

                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                    Show definition

                                                                                                                                                                                                                                                                                                    zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone

                                                                                                                                                                                                                                                                                                    GET Get Enablement Setting for Zone permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                    • enterprise

                                                                                                                                                                                                                                                                                                    Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

                                                                                                                                                                                                                                                                                                    GET zones/:zone_identifier/origin_tls_client_auth/settings
                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "enabled": true
  }
}
                                                                                                                                                                                                                                                                                                    zone-level-authenticated-origin-pulls-set-enablement-for-zone

                                                                                                                                                                                                                                                                                                    PUT Set Enablement for Zone permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                    • enterprise

                                                                                                                                                                                                                                                                                                    Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

                                                                                                                                                                                                                                                                                                    PUT zones/:zone_identifier/origin_tls_client_auth/settings

                                                                                                                                                                                                                                                                                                    Required parameters

                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                    enabled
                                                                                                                                                                                                                                                                                                    boolean

                                                                                                                                                                                                                                                                                                    Indicates whether zone-level authenticated origin pulls is enabled

                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"enabled":true}'
                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "enabled": true
  }
}
                                                                                                                                                                                                                                                                                                    zone-level-authenticated-origin-pulls-upload-certificate

                                                                                                                                                                                                                                                                                                    POST Upload Certificate permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                    • enterprise

                                                                                                                                                                                                                                                                                                    Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

                                                                                                                                                                                                                                                                                                    POST zones/:zone_identifier/origin_tls_client_auth

                                                                                                                                                                                                                                                                                                    Required parameters

                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                    certificate
                                                                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                                                                    The zone's leaf certificate

                                                                                                                                                                                                                                                                                                    "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"
                                                                                                                                                                                                                                                                                                      private_key
                                                                                                                                                                                                                                                                                                      string

                                                                                                                                                                                                                                                                                                      The zone's private key

                                                                                                                                                                                                                                                                                                      "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"}'
                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "expires_on": "2100-01-01T05:20:00Z",
    "status": "active",
    "uploaded_on": "2019-10-28T18:11:23.37411Z"
  }
}
                                                                                                                                                                                                                                                                                                        zone-level-authenticated-origin-pulls-list-certificates

                                                                                                                                                                                                                                                                                                        GET List Certificates permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/origin_tls_client_auth
                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
      "issuer": "GlobalSign",
      "signature": "SHA256WithRSA",
      "expires_on": "2100-01-01T05:20:00Z",
      "status": "active",
      "uploaded_on": "2019-10-28T18:11:23.37411Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                        zone-level-authenticated-origin-pulls-get-certificate-details

                                                                                                                                                                                                                                                                                                        GET Get Certificate Details permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/origin_tls_client_auth/:identifier
                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "expires_on": "2100-01-01T05:20:00Z",
    "status": "active",
    "uploaded_on": "2019-10-28T18:11:23.37411Z"
  }
}
                                                                                                                                                                                                                                                                                                        zone-level-authenticated-origin-pulls-delete-certificate

                                                                                                                                                                                                                                                                                                        DELETE Delete Certificate permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                                        DELETE zones/:zone_identifier/origin_tls_client_auth/:identifier
                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "expires_on": "2100-01-01T05:20:00Z",
    "status": "active",
    "uploaded_on": "2019-10-28T18:11:23.37411Z"
  }
}

                                                                                                                                                                                                                                                                                                        Per-hostname Authenticated Origin Pull

                                                                                                                                                                                                                                                                                                        Setup a client certficate per hostname to be sent in a request to Origin

                                                                                                                                                                                                                                                                                                        per-hostname-authenticated-origin-pull

                                                                                                                                                                                                                                                                                                        Object definition

                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                        Show definition

                                                                                                                                                                                                                                                                                                        per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate

                                                                                                                                                                                                                                                                                                        POST Upload a Hostname Client Certificate permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                        • enterprise

                                                                                                                                                                                                                                                                                                        Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed

                                                                                                                                                                                                                                                                                                        POST zones/:zone_identifier/origin_tls_client_auth/hostnames/certificates

                                                                                                                                                                                                                                                                                                        Required parameters

                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                        certificate
                                                                                                                                                                                                                                                                                                        string

                                                                                                                                                                                                                                                                                                        The hostname certificate

                                                                                                                                                                                                                                                                                                        "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n"
                                                                                                                                                                                                                                                                                                          private_key
                                                                                                                                                                                                                                                                                                          string

                                                                                                                                                                                                                                                                                                          The hostname certificate's private key

                                                                                                                                                                                                                                                                                                          "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"
                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"certificate":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","private_key":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n"}'
                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "serial_number": "6743787633689793699141714808227354901",
    "expires_on": "2100-01-01T05:20:00Z",
    "status": "active",
    "uploaded_on": "2019-10-28T18:11:23.37411Z"
  }
}
                                                                                                                                                                                                                                                                                                            per-hostname-authenticated-origin-pull-list-certificates

                                                                                                                                                                                                                                                                                                            GET List Certificates permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/origin_tls_client_auth/hostnames/certificates
                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "hostname": "app.example.com",
      "cert_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
      "enabled": true,
      "status": "active",
      "created_at": "2100-01-01T05:20:00Z",
      "updated_at": "2100-01-01T05:20:00Z",
      "cert_status": "active",
      "issuer": "GlobalSign",
      "signature": "SHA256WithRSA",
      "serial_number": "6743787633689793699141714808227354901",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
      "cert_uploaded_on": "2019-10-28T18:11:23.37411Z",
      "cert_updated_at": "2100-01-01T05:20:00Z",
      "expires_on": "2100-01-01T05:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                            per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate

                                                                                                                                                                                                                                                                                                            GET Get the Hostname Client Certificate permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                                            Get the certificate by ID to be used for client authentication on a hostname

                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/origin_tls_client_auth/hostnames/certificates/:identifier
                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "serial_number": "6743787633689793699141714808227354901",
    "expires_on": "2100-01-01T05:20:00Z",
    "status": "active",
    "uploaded_on": "2019-10-28T18:11:23.37411Z"
  }
}
                                                                                                                                                                                                                                                                                                            per-hostname-authenticated-origin-pull-delete-hostname-client-certificate

                                                                                                                                                                                                                                                                                                            DELETE Delete Hostname Client Certificate permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                                            DELETE zones/:zone_identifier/origin_tls_client_auth/hostnames/certificates/:identifier
                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/certificates/2458ce5a-0c35-4c7f-82c7-8e9487d3ff60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "serial_number": "6743787633689793699141714808227354901",
    "expires_on": "2100-01-01T05:20:00Z",
    "status": "active",
    "uploaded_on": "2019-10-28T18:11:23.37411Z"
  }
}
                                                                                                                                                                                                                                                                                                            per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication

                                                                                                                                                                                                                                                                                                            PUT Enable or Disable a Hostname for Client Authentication permission needed: #ssl:edit
                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                            • enterprise

                                                                                                                                                                                                                                                                                                            Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed

                                                                                                                                                                                                                                                                                                            PUT zones/:zone_identifier/origin_tls_client_auth/hostnames

                                                                                                                                                                                                                                                                                                            Required parameters

                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                            config
                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                            [ { "hostname": "app.example.com", "cert_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", "enabled": true } ]
                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"config":[{"hostname":"app.example.com","cert_id":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","enabled":true}]}'
                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "hostname": "app.example.com",
      "cert_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
      "enabled": true,
      "status": "active",
      "created_at": "2100-01-01T05:20:00Z",
      "updated_at": "2100-01-01T05:20:00Z",
      "cert_status": "active",
      "issuer": "GlobalSign",
      "signature": "SHA256WithRSA",
      "serial_number": "6743787633689793699141714808227354901",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
      "cert_uploaded_on": "2019-10-28T18:11:23.37411Z",
      "cert_updated_at": "2100-01-01T05:20:00Z",
      "expires_on": "2100-01-01T05:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                              per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication

                                                                                                                                                                                                                                                                                                              GET Get the Hostname Status for Client Authentication permission needed: #ssl:read
                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                              • enterprise

                                                                                                                                                                                                                                                                                                              GET zones/:zone_identifier/origin_tls_client_auth/hostnames/:hostname
                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/origin_tls_client_auth/hostnames/app.example.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "hostname": "app.example.com",
    "cert_id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "enabled": true,
    "status": "active",
    "created_at": "2100-01-01T05:20:00Z",
    "updated_at": "2100-01-01T05:20:00Z",
    "cert_status": "active",
    "issuer": "GlobalSign",
    "signature": "SHA256WithRSA",
    "serial_number": "6743787633689793699141714808227354901",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n",
    "cert_uploaded_on": "2019-10-28T18:11:23.37411Z",
    "cert_updated_at": "2100-01-01T05:20:00Z",
    "expires_on": "2100-01-01T05:20:00Z"
  }
}

                                                                                                                                                                                                                                                                                                              Stream Videos

                                                                                                                                                                                                                                                                                                              You can upload videos to Cloudflare Stream for fast video processing and delivery.

                                                                                                                                                                                                                                                                                                              stream-videos

                                                                                                                                                                                                                                                                                                              Object definition

                                                                                                                                                                                                                                                                                                              View properties and constraints defined on the object

                                                                                                                                                                                                                                                                                                              Show definition

                                                                                                                                                                                                                                                                                                              stream-videos-upload-a-video-from-a-url

                                                                                                                                                                                                                                                                                                              POST Upload a video from a URL

                                                                                                                                                                                                                                                                                                              Link to a video and it will be downloaded and made available on Stream.

                                                                                                                                                                                                                                                                                                              POST accounts/:account_identifier/stream/copy

                                                                                                                                                                                                                                                                                                              Required parameters

                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                              url
                                                                                                                                                                                                                                                                                                              string (uri)

                                                                                                                                                                                                                                                                                                              URL to the video. Server must be publicly routable and support HTTP HEAD requests and HTTP GET range requests. Server should respond to HTTP HEAD requests with a content-range header with the size of the file.

                                                                                                                                                                                                                                                                                                              "https://example.com/myvideo.mp4"

                                                                                                                                                                                                                                                                                                                Optional parameters

                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                thumbnailTimestampPct
                                                                                                                                                                                                                                                                                                                number

                                                                                                                                                                                                                                                                                                                Timestamp location of thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image will be from 0s of the video.

                                                                                                                                                                                                                                                                                                                0.529241
                                                                                                                                                                                                                                                                                                                • default value: 0
                                                                                                                                                                                                                                                                                                                • min value:0
                                                                                                                                                                                                                                                                                                                • max value:1
                                                                                                                                                                                                                                                                                                                allowedOrigins
                                                                                                                                                                                                                                                                                                                array

                                                                                                                                                                                                                                                                                                                List which origins should be allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty array will allow the video to be viewed on any origin.

                                                                                                                                                                                                                                                                                                                [ "example.com" ]
                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                  requireSignedURLs
                                                                                                                                                                                                                                                                                                                  boolean

                                                                                                                                                                                                                                                                                                                  Indicates whether the video can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the video.

                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                  watermark
                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                  { "uid": "ea95132c15732412d22c1476fa83f27a" }
                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/copy" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"url":"https://example.com/myvideo.mp4","thumbnailTimestampPct":0.529241,"allowedOrigins":["example.com"],"requireSignedURLs":true,"watermark":{"uid":"ea95132c15732412d22c1476fa83f27a"}}'
                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "allowedOrigins": [
      "example.com"
    ],
    "created": "2014-01-02T02:20:00Z",
    "duration": 300,
    "input": {
      "height": 1080,
      "width": 1920
    },
    "maxDurationSeconds": 300,
    "meta": {},
    "modified": "2014-01-02T02:20:00Z",
    "uploadExpiry": "2014-01-02T02:20:00Z",
    "playback": {
      "hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
      "dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
    },
    "preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
    "readyToStream": true,
    "requireSignedURLs": true,
    "size": 4190963,
    "status": {
      "state": "inprogress",
      "pctComplete": 51,
      "errorReasonCode": "ERR_NON_VIDEO",
      "errorReasonText": "The file was not recognized as a valid video file."
    },
    "thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
    "thumbnailTimestampPct": 0.529241,
    "uid": "ea95132c15732412d22c1476fa83f27a",
    "uploaded": "2014-01-02T02:20:00Z",
    "watermark": {
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "size": 29472,
      "height": 600,
      "width": 400,
      "created": "2014-01-02T02:20:00Z",
      "downloadedFrom": "https://company.com/logo.png",
      "name": "Marketing Videos",
      "opacity": 0.75,
      "padding": 0.1,
      "scale": 0.1,
      "position": "center"
    },
    "nft": {
      "contract": "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85",
      "token": 5
    }
  }
}
                                                                                                                                                                                                                                                                                                                    stream-videos-upload-a-video-using-a-single-http-request

                                                                                                                                                                                                                                                                                                                    POST Upload a video using a single HTTP request

                                                                                                                                                                                                                                                                                                                    You can upload a video up to 200 Megabytes using a single HTTP POST (multipart/form-data) request. For larger file sizes, please upload using the TUS protocol.

                                                                                                                                                                                                                                                                                                                    POST accounts/:account_identifier/stream

                                                                                                                                                                                                                                                                                                                    Required parameters

                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                    file
                                                                                                                                                                                                                                                                                                                    string

                                                                                                                                                                                                                                                                                                                    Video file to upload

                                                                                                                                                                                                                                                                                                                    "@/Users/kyle/Desktop/skiing.mp4"
                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     --form 'file=@/Users/kyle/Desktop/skiing.mp4'
                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "allowedOrigins": [
        "example.com"
      ],
      "created": "2014-01-02T02:20:00Z",
      "duration": 300,
      "input": {
        "height": 1080,
        "width": 1920
      },
      "maxDurationSeconds": 300,
      "meta": {},
      "modified": "2014-01-02T02:20:00Z",
      "uploadExpiry": "2014-01-02T02:20:00Z",
      "playback": {
        "hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
        "dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
      },
      "preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
      "readyToStream": true,
      "requireSignedURLs": true,
      "size": 4190963,
      "status": {
        "state": "inprogress",
        "pctComplete": 51,
        "errorReasonCode": "ERR_NON_VIDEO",
        "errorReasonText": "The file was not recognized as a valid video file."
      },
      "thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
      "thumbnailTimestampPct": 0.529241,
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "uploaded": "2014-01-02T02:20:00Z",
      "watermark": null,
      "nft": {
        "contract": "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85",
        "token": 5
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                      stream-videos-create-a-video-and-get-authenticated-direct-upload-url

                                                                                                                                                                                                                                                                                                                      POST Create a video and get authenticated direct upload URL

                                                                                                                                                                                                                                                                                                                      Direct uploads allow users to upload videos without API keys. A common place to use direct uploads is on web apps, client side applications, or on mobile devices where users upload content directly to Stream.

                                                                                                                                                                                                                                                                                                                      POST accounts/:account_identifier/stream/direct_upload

                                                                                                                                                                                                                                                                                                                      Required parameters

                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                      maxDurationSeconds
                                                                                                                                                                                                                                                                                                                      integer

                                                                                                                                                                                                                                                                                                                      Direct uploads occupy minutes of videos on your Stream account until they are expired. This value will be used to calculate the duration the video will occupy before the video is uploaded. After upload, the duration of the uploaded will be used instead. If a video longer than this value is uploaded, the video will result in an error.

                                                                                                                                                                                                                                                                                                                      300
                                                                                                                                                                                                                                                                                                                      • min value:1
                                                                                                                                                                                                                                                                                                                      • max value:21600

                                                                                                                                                                                                                                                                                                                      Optional parameters

                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                      expiry
                                                                                                                                                                                                                                                                                                                      string (date-time)

                                                                                                                                                                                                                                                                                                                      The date after upload will not be accepted

                                                                                                                                                                                                                                                                                                                      "2021-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                      • default value: Now + 30 minutes
                                                                                                                                                                                                                                                                                                                      thumbnailTimestampPct
                                                                                                                                                                                                                                                                                                                      number

                                                                                                                                                                                                                                                                                                                      Timestamp location of thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image will be from 0s of the video.

                                                                                                                                                                                                                                                                                                                      0.529241
                                                                                                                                                                                                                                                                                                                      • default value: 0
                                                                                                                                                                                                                                                                                                                      • min value:0
                                                                                                                                                                                                                                                                                                                      • max value:1
                                                                                                                                                                                                                                                                                                                      allowedOrigins
                                                                                                                                                                                                                                                                                                                      array

                                                                                                                                                                                                                                                                                                                      List which origins should be allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty array will allow the video to be viewed on any origin.

                                                                                                                                                                                                                                                                                                                      [ "example.com" ]
                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                        requireSignedURLs
                                                                                                                                                                                                                                                                                                                        boolean

                                                                                                                                                                                                                                                                                                                        Indicates whether the video can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the video.

                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                        watermark
                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                        { "uid": "ea95132c15732412d22c1476fa83f27a" }
                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/direct_upload" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"maxDurationSeconds":300,"expiry":"2021-01-02T02:20:00Z","thumbnailTimestampPct":0.529241,"allowedOrigins":["example.com"],"requireSignedURLs":true,"watermark":{"uid":"ea95132c15732412d22c1476fa83f27a"}}'
                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uploadURL": "www.example.com/samplepath",
    "uid": "ea95132c15732412d22c1476fa83f27a",
    "watermark": {
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "size": 29472,
      "height": 600,
      "width": 400,
      "created": "2014-01-02T02:20:00Z",
      "downloadedFrom": "https://company.com/logo.png",
      "name": "Marketing Videos",
      "opacity": 0.75,
      "padding": 0.1,
      "scale": 0.1,
      "position": "center"
    }
  }
}
                                                                                                                                                                                                                                                                                                                          stream-videos-list-videos

                                                                                                                                                                                                                                                                                                                          GET List videos

                                                                                                                                                                                                                                                                                                                          Up to 1000 videos can be listed with one request, use optional parameters below to get a specific range of videos.

                                                                                                                                                                                                                                                                                                                          Please note that Cloudflare Stream does not use pagination, instead it uses a cursor pattern to list more than 1000 videos. In order to list all videos, make multiple requests to the API using the created date-time of the last item in the previous request as the before or after parameter.

                                                                                                                                                                                                                                                                                                                          GET accounts/:account_identifier/stream

                                                                                                                                                                                                                                                                                                                          Optional parameters

                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                          after
                                                                                                                                                                                                                                                                                                                          string (date-time)

                                                                                                                                                                                                                                                                                                                          Show videos created after this date-time

                                                                                                                                                                                                                                                                                                                          "2014-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                            before
                                                                                                                                                                                                                                                                                                                            string (date-time)

                                                                                                                                                                                                                                                                                                                            Show videos created before this time

                                                                                                                                                                                                                                                                                                                            "2014-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                              include_counts
                                                                                                                                                                                                                                                                                                                              boolean

                                                                                                                                                                                                                                                                                                                              Include stats in the response about the number of videos in response range and total number of videos available

                                                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                              search
                                                                                                                                                                                                                                                                                                                              string

                                                                                                                                                                                                                                                                                                                              A string provided in this field will be used to search over the 'name' key in meta field, which can be set with the upload request of after.

                                                                                                                                                                                                                                                                                                                              "puppy.mp4"
                                                                                                                                                                                                                                                                                                                                limit
                                                                                                                                                                                                                                                                                                                                integer

                                                                                                                                                                                                                                                                                                                                Number of videos to include in the response

                                                                                                                                                                                                                                                                                                                                • min value:0
                                                                                                                                                                                                                                                                                                                                • max value:1000
                                                                                                                                                                                                                                                                                                                                asc
                                                                                                                                                                                                                                                                                                                                boolean

                                                                                                                                                                                                                                                                                                                                List videos in ascending order of creation

                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                status
                                                                                                                                                                                                                                                                                                                                string

                                                                                                                                                                                                                                                                                                                                Filter by statuses

                                                                                                                                                                                                                                                                                                                                "downloading,queued,inprogress,ready,error"
                                                                                                                                                                                                                                                                                                                                • default value: downloading,queued,inprogress,ready,error
                                                                                                                                                                                                                                                                                                                                • valid values: pendingupload, downloading, queued, inprogress, ready, error
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream?after=2014-01-02T02:20:00Z&before=2014-01-02T02:20:00Z&include_counts=false&search=puppy.mp4&limit=undefined&asc=false&status=downloading,queued,inprogress,ready,error" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "allowedOrigins": [
        "example.com"
      ],
      "created": "2014-01-02T02:20:00Z",
      "duration": 300,
      "input": {
        "height": 1080,
        "width": 1920
      },
      "maxDurationSeconds": 300,
      "meta": {},
      "modified": "2014-01-02T02:20:00Z",
      "uploadExpiry": "2014-01-02T02:20:00Z",
      "playback": {
        "hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
        "dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
      },
      "preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
      "readyToStream": true,
      "requireSignedURLs": true,
      "size": 4190963,
      "status": {
        "state": "inprogress",
        "pctComplete": 51,
        "errorReasonCode": "ERR_NON_VIDEO",
        "errorReasonText": "The file was not recognized as a valid video file."
      },
      "thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
      "thumbnailTimestampPct": 0.529241,
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "uploaded": "2014-01-02T02:20:00Z",
      "watermark": {
        "uid": "ea95132c15732412d22c1476fa83f27a",
        "size": 29472,
        "height": 600,
        "width": 400,
        "created": "2014-01-02T02:20:00Z",
        "downloadedFrom": "https://company.com/logo.png",
        "name": "Marketing Videos",
        "opacity": 0.75,
        "padding": 0.1,
        "scale": 0.1,
        "position": "center"
      },
      "nft": {
        "contract": "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85",
        "token": 5
      }
    }
  ],
  "total": "35586",
  "range": "1000"
}
                                                                                                                                                                                                                                                                                                                                stream-videos-initiate-a-video-upload-using-tus

                                                                                                                                                                                                                                                                                                                                POST Initiate a Video Upload using TUS

                                                                                                                                                                                                                                                                                                                                Initiate a video upload using the TUS protocol. On success, server will response with status code 201 (Created) and include a 'location' header indicating where the video content should be uploaded to. See https://tus.io for protocol details.

                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/stream
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Tus-Resumable: 1.0.0" \
     -H "Upload-Length: 900000000"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                stream-videos-video-details
                                                                                                                                                                                                                                                                                                                                GET Video details 
                                                                                                                                                                                                                                                                                                                                Fetch details of a single video.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/stream/:identifier
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "allowedOrigins": [
      "example.com"
    ],
    "created": "2014-01-02T02:20:00Z",
    "duration": 300,
    "input": {
      "height": 1080,
      "width": 1920
    },
    "maxDurationSeconds": 300,
    "meta": {},
    "modified": "2014-01-02T02:20:00Z",
    "uploadExpiry": "2014-01-02T02:20:00Z",
    "playback": {
      "hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
      "dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
    },
    "preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
    "readyToStream": true,
    "requireSignedURLs": true,
    "size": 4190963,
    "status": {
      "state": "inprogress",
      "pctComplete": 51,
      "errorReasonCode": "ERR_NON_VIDEO",
      "errorReasonText": "The file was not recognized as a valid video file."
    },
    "thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
    "thumbnailTimestampPct": 0.529241,
    "uid": "ea95132c15732412d22c1476fa83f27a",
    "uploaded": "2014-01-02T02:20:00Z",
    "watermark": {
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "size": 29472,
      "height": 600,
      "width": 400,
      "created": "2014-01-02T02:20:00Z",
      "downloadedFrom": "https://company.com/logo.png",
      "name": "Marketing Videos",
      "opacity": 0.75,
      "padding": 0.1,
      "scale": 0.1,
      "position": "center"
    },
    "nft": {
      "contract": "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85",
      "token": 5
    }
  }
}
                                                                                                                                                                                                                                                                                                                                stream-videos-embed-code-html
                                                                                                                                                                                                                                                                                                                                GET Embed Code HTML 
                                                                                                                                                                                                                                                                                                                                Fetch an HTML code snippet that can be used to embed the video in a web page that is delivered through Cloudflare. On success returns an HTML fragment (not a full document) that can be included on a web page to display the video. On failure returns a JSON response body (see Error Response) above.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/stream/:identifier/embed
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a/embed" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                <stream id="ea95132c15732412d22c1476fa83f27a"></stream><script data-cfasync="false" defer type="text/javascript" src="https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js"></script>
                                                                                                                                                                                                                                                                                                                                stream-videos-delete-video
                                                                                                                                                                                                                                                                                                                                DELETE Delete video 
                                                                                                                                                                                                                                                                                                                                Delete a video on Cloudflare Stream. On success, all copies of the video are deleted.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                DELETE accounts/:account_identifier/stream/:identifier
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                stream-videos-associate-video-to-an-nft
                                                                                                                                                                                                                                                                                                                                POST Associate video to an NFT 
                                                                                                                                                                                                                                                                                                                                By associating a token ID and contract address on Stream videos, you make it possible to transfer admin rights on a video. If a change in ownership of the ERC-721 token happens on the Ethereum blockchain, the new owner of the token may claim control over of the video.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/stream/:identifier
                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                contract
                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                ERC-721 compatible contract address
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85"
                                                                                                                                                                                                                                                                                                                                • min length: 42
                                                                                                                                                                                                                                                                                                                                • max length: 42
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                token
                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                Token ID for the NFT
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                5
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"contract":"0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85","token":5}'
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "allowedOrigins": [
        "example.com"
      ],
      "created": "2014-01-02T02:20:00Z",
      "duration": 300,
      "input": {
        "height": 1080,
        "width": 1920
      },
      "maxDurationSeconds": 300,
      "meta": {},
      "modified": "2014-01-02T02:20:00Z",
      "uploadExpiry": "2014-01-02T02:20:00Z",
      "playback": {
        "hls": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8",
        "dash": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd"
      },
      "preview": "https://watch.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a",
      "readyToStream": true,
      "requireSignedURLs": true,
      "size": 4190963,
      "status": {
        "state": "inprogress",
        "pctComplete": 51,
        "errorReasonCode": "ERR_NON_VIDEO",
        "errorReasonText": "The file was not recognized as a valid video file."
      },
      "thumbnail": "https://videodelivery.net/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg",
      "thumbnailTimestampPct": 0.529241,
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "uploaded": "2014-01-02T02:20:00Z",
      "watermark": {
        "uid": "ea95132c15732412d22c1476fa83f27a",
        "size": 29472,
        "height": 600,
        "width": 400,
        "created": "2014-01-02T02:20:00Z",
        "downloadedFrom": "https://company.com/logo.png",
        "name": "Marketing Videos",
        "opacity": 0.75,
        "padding": 0.1,
        "scale": 0.1,
        "position": "center"
      },
      "nft": {
        "contract": "0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85",
        "token": 5
      }
    }
  ],
  "total": "35586",
  "range": "1000"
}
                                                                                                                                                                                                                                                                                                                                stream-videos-create-a-signed-url-token-for-a-video
                                                                                                                                                                                                                                                                                                                                POST Create a signed URL token for a video 
                                                                                                                                                                                                                                                                                                                                Create a signed URL token for a video. If no body is provided in the request, a token will be created with default values.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/stream/:identifier/token
                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                id
                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                Optional id of a Stream signing key. If present, the 'pem' field is also required.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                "ab0d4ef71g4425f8dcba9041231813000"
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                pem
                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                Optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the 'id' field is also required.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo="
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                exp
                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                Optional unix epoch timestamp after which the token will not be accepted, up to a maximum of 24 hours from issuing time. If not set, defaults to one hour after issuing.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                1621555515
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                nbf
                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                Optional unix epoch timestamp before which the token will not be accepted.  If not set, defaults to one hour before issuing.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                1621548315
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                downloadable
                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                Optional boolean value which enables the signed token to be used to access mp4 download links for the video.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                accessRules
                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                Optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access Rules are evaluated first-to-last. If a Rule matches, the associated action is applied and no further rules are evaluated.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                [
  {
    "type": "ip.geoip.country",
    "country": [
      "US",
      "MX"
    ],
    "action": "block"
  },
  {
    "type": "ip.src",
    "ip": [
      "93.184.216.0/24",
      "2400:cb00::/32"
    ],
    "action": "allow"
  },
  {
    "type": "any",
    "action": "block"
  }
]
                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/ea95132c15732412d22c1476fa83f27a/token" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"ab0d4ef71g4425f8dcba9041231813000","pem":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","exp":1621555515,"nbf":1621548315,"downloadable":false,"accessRules":[{"type":"ip.geoip.country","country":["US","MX"],"action":"block"},{"type":"ip.src","ip":["93.184.216.0/24","2400:cb00::/32"],"action":"allow"},{"type":"any","action":"block"}]}'
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A"
  }
}
                                                                                                                                                                                                                                                                                                                                Stream Videos error codes
                                                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                                                10000Internal Server Error
                                                                                                                                                                                                                                                                                                                                10001Authentication Failure
                                                                                                                                                                                                                                                                                                                                100013Conflict: Media has been modified since last request
                                                                                                                                                                                                                                                                                                                                10002Authorization Failure: Credential not authorized
                                                                                                                                                                                                                                                                                                                                10003Not Found: Resource not found
                                                                                                                                                                                                                                                                                                                                10004Decoding Error: Cannot decode request body
                                                                                                                                                                                                                                                                                                                                10005Bad Request
                                                                                                                                                                                                                                                                                                                                10006Beta Access Error
                                                                                                                                                                                                                                                                                                                                10007Forbidden: Copy upload not enabled
                                                                                                                                                                                                                                                                                                                                10008Invalid Duration
                                                                                                                                                                                                                                                                                                                                10009Forbidden: Allowed key count exceeded
                                                                                                                                                                                                                                                                                                                                10010Invalid URL
                                                                                                                                                                                                                                                                                                                                10011File size too large
                                                                                                                                                                                                                                                                                                                                10012Forbidden: Webhook feature not enabled
                                                                                                                                                                                                                                                                                                                                10014File size too large
                                                                                                                                                                                                                                                                                                                                10015Chunk size is too small
                                                                                                                                                                                                                                                                                                                                10016Too Many Requests
                                                                                                                                                                                                                                                                                                                                10017Expiration for upload has passed
                                                                                                                                                                                                                                                                                                                                10018Video already uploaded
                                                                                                                                                                                                                                                                                                                                10019Invalid Percentage Range
                                                                                                                                                                                                                                                                                                                                Stream Signing Keys
                                                                                                                                                                                                                                                                                                                                Stream signing keys are required to use signed URLs with Stream videos.
                                                                                                                                                                                                                                                                                                                                stream-signing-keys
                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                stream-signing-keys-create-a-signing-key
                                                                                                                                                                                                                                                                                                                                POST Create a Signing Key 
                                                                                                                                                                                                                                                                                                                                Upon creation you will get a RSA private key in PEM and JWK formats. Keys are created, used and deleted independently of videos. Every key can sign any of your videos. Key files are displayed only once upon creation.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/stream/keys
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/keys" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "5213cfa121f70b8c1380686ffc371ba3",
    "pem": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=",
    "jwk": "eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=",
    "created": "2014-01-02T02:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                stream-signing-keys-list-signing-keys
                                                                                                                                                                                                                                                                                                                                GET List Signing Keys 
                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/stream/keys
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/keys" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "5213cfa121f70b8c1380686ffc371ba3",
      "created": "2014-01-02T02:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                stream-signing-keys-delete-key
                                                                                                                                                                                                                                                                                                                                DELETE Delete key 
                                                                                                                                                                                                                                                                                                                                Deleting a key revokes all signed URLs generated with the key.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                DELETE accounts/:account_identifier/stream/keys/:identifier
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/keys/5213cfa121f70b8c1380686ffc371ba3" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": ""
}
                                                                                                                                                                                                                                                                                                                                Stream MP4 Downloads
                                                                                                                                                                                                                                                                                                                                Create .mp4 files for offline viewing and downloading.
                                                                                                                                                                                                                                                                                                                                stream-mp4-downloads
                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                stream-mp4-downloads-create-downloads
                                                                                                                                                                                                                                                                                                                                POST Create downloads 
                                                                                                                                                                                                                                                                                                                                Create downloads for a video, this can only be done if the video is ready to view.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/stream/:video_identifier/downloads
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/downloads" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "default": {
      "url": "https://videodelivery.net/7227269b8c5324f9b9a68502e80df65a/downloads/default.mp4",
      "status": "ready",
      "percentComplete": "100.0"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                stream-mp4-downloads-list-downloads
                                                                                                                                                                                                                                                                                                                                GET List downloads 
                                                                                                                                                                                                                                                                                                                                View the downloads created for this video
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/stream/:video_identifier/downloads
                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/downloads" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "default": {
      "url": "https://videodelivery.net/7227269b8c5324f9b9a68502e80df65a/downloads/default.mp4",
      "status": "ready",
      "percentComplete": "100.0"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                Stream Subtitles/Captions
                                                                                                                                                                                                                                                                                                                                Add subtitles or captions to Stream videos for any language.
                                                                                                                                                                                                                                                                                                                                stream-subtitles/captions
                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                stream-subtitles/captions-upload-a-caption/subtitle
                                                                                                                                                                                                                                                                                                                                PUT Upload a caption/subtitle 
                                                                                                                                                                                                                                                                                                                                Upload the file to the endpoint for a specific BCP47 language. One caption/subtitle per language is allowed.
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/stream/:video_identifier/captions/:language
                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                file
                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                WebVTT file to upload
                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                "@/Users/kyle/Desktop/tr.vtt"
                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/captions/tr" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     --form 'file=@/Users/kyle/Desktop/tr.vtt'
                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "label": "Türkçe",
    "language": "tr"
  }
}
                                                                                                                                                                                                                                                                                                                                  stream-subtitles/captions-list-captions/subtitles
                                                                                                                                                                                                                                                                                                                                  GET List captions/subtitles 
                                                                                                                                                                                                                                                                                                                                  View the currently available captions for a specific video.
                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/stream/:video_identifier/captions
                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/captions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "label": "Türkçe",
      "language": "tr"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                  stream-subtitles/captions-delete-a-caption/subtitle
                                                                                                                                                                                                                                                                                                                                  DELETE Delete a caption/subtitle 
                                                                                                                                                                                                                                                                                                                                  Remove the caption or subtitle from a video
                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                  DELETE accounts/:account_identifier/stream/:video_identifier/captions/:language
                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/ea95132c15732412d22c1476fa83f27a/captions/tr" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": ""
}
                                                                                                                                                                                                                                                                                                                                  Stream Webhook
                                                                                                                                                                                                                                                                                                                                  Create a webhook to notify your service when videos are ready to stream.
                                                                                                                                                                                                                                                                                                                                  stream-webhook
                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                  stream-webhook-create-a-webhook
                                                                                                                                                                                                                                                                                                                                  PUT Create a webhook 
                                                                                                                                                                                                                                                                                                                                  PUT accounts/:account_identifier/stream/webhook
                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                  notificationUrl
                                                                                                                                                                                                                                                                                                                                  string (url)
                                                                                                                                                                                                                                                                                                                                  The URL the webhooks will be sent to
                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                  "https://example.com"
                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/webhook" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"notificationUrl":"https://example.com"}'
                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "notificationUrl": "https://example.com",
    "modified": "2014-01-02T02:20:00Z",
    "secret": "0b1c2423aa030a11583c6ffadda57fad681d00cd"
  }
}
                                                                                                                                                                                                                                                                                                                                    stream-webhook-view-the-webhook
                                                                                                                                                                                                                                                                                                                                    GET View the webhook 
                                                                                                                                                                                                                                                                                                                                    GET accounts/:account_identifier/stream/webhook
                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/webhook" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "notificationUrl": "https://example.com",
    "modified": "2014-01-02T02:20:00Z",
    "secret": "0b1c2423aa030a11583c6ffadda57fad681d00cd"
  }
}
                                                                                                                                                                                                                                                                                                                                    stream-webhook-delete-the-webhook
                                                                                                                                                                                                                                                                                                                                    DELETE Delete the webhook 
                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:account_identifier/stream/webhook
                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/webhook" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": ""
}
                                                                                                                                                                                                                                                                                                                                    Stream Webhook error codes
                                                                                                                                                                                                                                                                                                                                    CodeDescription
                                                                                                                                                                                                                                                                                                                                    10000Internal Server Error
                                                                                                                                                                                                                                                                                                                                    10001Authentication Failure
                                                                                                                                                                                                                                                                                                                                    Stream Watermark Profile
                                                                                                                                                                                                                                                                                                                                    You can create watermark profile for different videos.
                                                                                                                                                                                                                                                                                                                                    stream-watermark-profile
                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                    stream-watermark-profile-create-a-watermark-profile-from-an-url
                                                                                                                                                                                                                                                                                                                                    POST Create a Watermark Profile from an URL 
                                                                                                                                                                                                                                                                                                                                    You can create a watermark profile by specifying the URL to the image.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    POST accounts/:account_identifier/stream/watermarks
                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                    url
                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                    The source URL to the image where it was downloaded from. If the watermark profile was created via direct upload, this field will be null.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    "https://company.com/logo.png"
                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                    A short description for the profile.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    "Marketing Videos"
                                                                                                                                                                                                                                                                                                                                    • default value: 
                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                    opacity
                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                    Translucency of the image. 0.0 means completely transparent, and 1.0 means completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make it completely opaque.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    0.75
                                                                                                                                                                                                                                                                                                                                    • default value: 1
                                                                                                                                                                                                                                                                                                                                    • min value:0
                                                                                                                                                                                                                                                                                                                                    • max value:1
                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                    padding
                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                    Whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 means no padding, and 1.0 means padded full video width or length, determined by the algorithm.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    0.1
                                                                                                                                                                                                                                                                                                                                    • default value: 0.05
                                                                                                                                                                                                                                                                                                                                    • min value:0
                                                                                                                                                                                                                                                                                                                                    • max value:1
                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                    scale
                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                    The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 means no scaling (use the size of the image as-is), and 1.0 fills the entire video.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    0.1
                                                                                                                                                                                                                                                                                                                                    • default value: 0.15
                                                                                                                                                                                                                                                                                                                                    • min value:0
                                                                                                                                                                                                                                                                                                                                    • max value:1
                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                    position
                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                    Location of the image. Valid positions are: "upperRight", "upperLeft", "lowerLeft", "lowerRight", and "center". Note that "center" will ignore the "padding" parameter. 
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    "center"
                                                                                                                                                                                                                                                                                                                                    • default value: upperRight
                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/watermarks" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"url":"https://company.com/logo.png","name":"Marketing Videos","opacity":0.75,"padding":0.1,"scale":0.1,"position":"center"}'
                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uid": "ea95132c15732412d22c1476fa83f27a",
    "size": 29472,
    "height": 600,
    "width": 400,
    "created": "2014-01-02T02:20:00Z",
    "downloadedFrom": "https://company.com/logo.png",
    "name": "Marketing Videos",
    "opacity": 0.75,
    "padding": 0.1,
    "scale": 0.1,
    "position": "center"
  }
}
                                                                                                                                                                                                                                                                                                                                    stream-watermark-profile-create-a-watermark-profile-via-basic-upload
                                                                                                                                                                                                                                                                                                                                    POST Create a Watermark Profile via Basic Upload 
                                                                                                                                                                                                                                                                                                                                    You can create a watermark profile using a single HTTP POST (multipart/form-data) request.
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    POST accounts/:account_identifier/stream/watermarks
                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                    file
                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                    Image file to upload
                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                    "@/Users/rchen/Downloads/watermark.png"
                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                      A short description for the profile.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      "Marketing Videos"
                                                                                                                                                                                                                                                                                                                                      • default value: 
                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                      opacity
                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                      Translucency of the image. 0.0 means completely transparent, and 1.0 means completely opaque. Note that if the image is already semi-transparent, setting this to 1.0 will not make it completely opaque.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      0.75
                                                                                                                                                                                                                                                                                                                                      • default value: 1
                                                                                                                                                                                                                                                                                                                                      • min value:0
                                                                                                                                                                                                                                                                                                                                      • max value:1
                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                      padding
                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                      Whitespace between the adjacent edges (determined by position) of the video and the image. 0.0 means no padding, and 1.0 means padded full video width or length, determined by the algorithm.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      0.1
                                                                                                                                                                                                                                                                                                                                      • default value: 0.05
                                                                                                                                                                                                                                                                                                                                      • min value:0
                                                                                                                                                                                                                                                                                                                                      • max value:1
                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                      scale
                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                      The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. 0.0 means no scaling (use the size of the image as-is), and 1.0 fills the entire video.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      0.1
                                                                                                                                                                                                                                                                                                                                      • default value: 0.15
                                                                                                                                                                                                                                                                                                                                      • min value:0
                                                                                                                                                                                                                                                                                                                                      • max value:1
                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                      position
                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                      Location of the image. Valid positions are: "upperRight", "upperLeft", "lowerLeft", "lowerRight", and "center". Note that "center" will ignore the "padding" parameter. 
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      "center"
                                                                                                                                                                                                                                                                                                                                      • default value: upperRight
                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/watermarks" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     --form 'file=@/Users/rchen/Downloads/watermark.png' \
     --form 'name=Marketing Videos' \
     --form 'opacity=0.75' \
     --form 'padding=0.1' \
     --form 'scale=0.1' \
     --form 'position=center'
                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uid": "ea95132c15732412d22c1476fa83f27a",
    "size": 29472,
    "height": 600,
    "width": 400,
    "created": "2014-01-02T02:20:00Z",
    "downloadedFrom": "https://company.com/logo.png",
    "name": "Marketing Videos",
    "opacity": 0.75,
    "padding": 0.1,
    "scale": 0.1,
    "position": "center"
  }
}
                                                                                                                                                                                                                                                                                                                                      stream-watermark-profile-list-watermark-profiles
                                                                                                                                                                                                                                                                                                                                      GET List Watermark Profiles 
                                                                                                                                                                                                                                                                                                                                      List all the watermark profiles under your account.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_identifier/stream/watermarks
                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/watermarks" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "uid": "ea95132c15732412d22c1476fa83f27a",
      "size": 29472,
      "height": 600,
      "width": 400,
      "created": "2014-01-02T02:20:00Z",
      "downloadedFrom": "https://company.com/logo.png",
      "name": "Marketing Videos",
      "opacity": 0.75,
      "padding": 0.1,
      "scale": 0.1,
      "position": "center"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                      stream-watermark-profile-watermark-profile-details
                                                                                                                                                                                                                                                                                                                                      GET Watermark Profile Details 
                                                                                                                                                                                                                                                                                                                                      Fetch details of a single watermark profile.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_identifier/stream/watermarks/:identifier
                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/watermarks/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uid": "ea95132c15732412d22c1476fa83f27a",
    "size": 29472,
    "height": 600,
    "width": 400,
    "created": "2014-01-02T02:20:00Z",
    "downloadedFrom": "https://company.com/logo.png",
    "name": "Marketing Videos",
    "opacity": 0.75,
    "padding": 0.1,
    "scale": 0.1,
    "position": "center"
  }
}
                                                                                                                                                                                                                                                                                                                                      stream-watermark-profile-delete-watermark-profile
                                                                                                                                                                                                                                                                                                                                      DELETE Delete Watermark Profile 
                                                                                                                                                                                                                                                                                                                                      Mark a watermark profile as deleted
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      DELETE accounts/:account_identifier/stream/watermarks/:identifier
                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/stream/watermarks/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": ""
}
                                                                                                                                                                                                                                                                                                                                      Stream Watermark Profile error codes
                                                                                                                                                                                                                                                                                                                                      CodeDescription
                                                                                                                                                                                                                                                                                                                                      10020Invalid Percentage Range for Opacity
                                                                                                                                                                                                                                                                                                                                      10021Invalid Percentage Range for Padding
                                                                                                                                                                                                                                                                                                                                      10022Invalid Percentage Range for Scale
                                                                                                                                                                                                                                                                                                                                      10023Invalid Value for Position
                                                                                                                                                                                                                                                                                                                                      10024Forbidden: Allowed watermark count exceeded
                                                                                                                                                                                                                                                                                                                                      Stream Connect
                                                                                                                                                                                                                                                                                                                                      Push RTMPS feeds to the Cloudflare edge and have them restreamed to your audience on any platform that supports RTMP
                                                                                                                                                                                                                                                                                                                                      stream-connect
                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                      stream-connect-create-a-live-input
                                                                                                                                                                                                                                                                                                                                      POST Create a live input 
                                                                                                                                                                                                                                                                                                                                      Create a live input that can be streamed to. Add an output in order to direct traffic.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      POST accounts/:account_identifier/stream/live_inputs
                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                      meta
                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                      User modifyable key-value store. Can use used for keeping references to another system of record for managing live inputs.
                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                      {
  "name": "test stream 1"
}
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"meta":{"name":"test stream 1"}}'
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uid": "66be4bf738797e01e1fca35a7bdecdcd",
    "meta": {
      "name": "test stream 1"
    },
    "created": "2014-01-02T02:20:00Z",
    "modified": "2014-01-02T02:20:00Z",
    "rtmps": {
      "url": "rtmps://live.cloudflare.com:443/live/",
      "streamKey": "MjE2OTAxNzQyMjQxNDkyNDYyNTAxNjc3MzE3NzY4MjAwMTYxODMxMjMxOTc66be4bf738797e01e1fca35a7bdecdcd"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                        stream-connect-list-live-inputs
                                                                                                                                                                                                                                                                                                                                        GET List live inputs 
                                                                                                                                                                                                                                                                                                                                        View the live inputs that have been created on this account. Some information is not included on list requests, such as the URL to stream to. To get that information, request a single live input.
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/stream/live_inputs
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "uid": "66be4bf738797e01e1fca35a7bdecdcd",
      "meta": {
        "name": "test stream 1"
      },
      "created": "2014-01-02T02:20:00Z",
      "modified": "2014-01-02T02:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                        stream-connect-live-input-details
                                                                                                                                                                                                                                                                                                                                        GET Live input details 
                                                                                                                                                                                                                                                                                                                                        Fetch details about a single live input
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/stream/live_inputs/:live_input_identifier
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs/66be4bf738797e01e1fca35a7bdecdcd" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uid": "66be4bf738797e01e1fca35a7bdecdcd",
    "meta": {
      "name": "test stream 1"
    },
    "created": "2014-01-02T02:20:00Z",
    "modified": "2014-01-02T02:20:00Z",
    "rtmps": {
      "url": "rtmps://live.cloudflare.com:443/live/",
      "streamKey": "MjE2OTAxNzQyMjQxNDkyNDYyNTAxNjc3MzE3NzY4MjAwMTYxODMxMjMxOTc66be4bf738797e01e1fca35a7bdecdcd"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                        stream-connect-delete-live-input
                                                                                                                                                                                                                                                                                                                                        DELETE Delete live input 
                                                                                                                                                                                                                                                                                                                                        Prevent a live input from being streamed to. This makes the live input inaccessible to any future API calls or RTMPS transmission
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        DELETE accounts/:account_identifier/stream/live_inputs/:live_input_identifier
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs/66be4bf738797e01e1fca35a7bdecdcd" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        stream-connect-add-an-output-to-a-live-input
                                                                                                                                                                                                                                                                                                                                        POST Add an output to a live input 
                                                                                                                                                                                                                                                                                                                                        Create a new output which will be restreamed to by a live input
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        POST accounts/:account_identifier/stream/live_inputs/:live_input_identifier/outputs
                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                        url
                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                        The URL a output will restream to
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        "rtmp://a.rtmp.youtube.com/live2"
                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                        streamKey
                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                        The streamKey used to authenticate against a output's target
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        "uzya-f19y-g2g9-a2ee-51j2"
                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs/66be4bf738797e01e1fca35a7bdecdcd/outputs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"url":"rtmp://a.rtmp.youtube.com/live2","streamKey":"uzya-f19y-g2g9-a2ee-51j2"}'
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uid": "baea4d9c515887b80289d5c33cf01145",
    "url": "rtmp://a.rtmp.youtube.com/live2",
    "streamKey": "uzya-f19y-g2g9-a2ee-51j2"
  }
}
                                                                                                                                                                                                                                                                                                                                        stream-connect-list-outputs-associated-with-a-live-input
                                                                                                                                                                                                                                                                                                                                        GET List outputs associated with a live input 
                                                                                                                                                                                                                                                                                                                                        Create a new output to restream to when a live input receives data
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/stream/live_inputs/:live_input_identifier/outputs
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs/66be4bf738797e01e1fca35a7bdecdcd/outputs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "uid": "baea4d9c515887b80289d5c33cf01145",
      "url": "rtmp://a.rtmp.youtube.com/live2",
      "streamKey": "uzya-f19y-g2g9-a2ee-51j2"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                        stream-connect-remove-an-output-from-a-live-input
                                                                                                                                                                                                                                                                                                                                        DELETE Remove an output from a live input 
                                                                                                                                                                                                                                                                                                                                        Remove an output from a live input
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        DELETE accounts/:account_identifier/stream/live_inputs/:live_input_identifier/outputs/:output_identifier
                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/stream/live_inputs/66be4bf738797e01e1fca35a7bdecdcd/outputs/baea4d9c515887b80289d5c33cf01145" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                        Cloudflare Images
                                                                                                                                                                                                                                                                                                                                        You can upload images to Cloudflare Images for fast image processing and delivery.
                                                                                                                                                                                                                                                                                                                                        cloudflare-images
                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                        cloudflare-images-upload-an-image-using-a-single-http-request
                                                                                                                                                                                                                                                                                                                                        POST Upload an image using a single HTTP request 
                                                                                                                                                                                                                                                                                                                                        You can upload a image up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        POST accounts/:account_identifier/images/v1
                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                        file
                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                        Image file to upload
                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                        "@/Users/kyle/Desktop/logo.png"
                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                          requireSignedURLs
                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                          Indicates whether the image requires a signature token for the access
                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                          metadata
                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                          User modifyable key-value store. Can use used for keeping references to another system of record for managing images.
                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                          "{\"meta\": \"metaID\"}"
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     --form 'file=@/Users/kyle/Desktop/logo.png' \
     --form 'requireSignedURLs=true' \
     --form 'metadata={"meta": "metaID"}'
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "ZxR0pLaXRldlBtaFhhO2FiZGVnaA",
      "filename": "avatar.png",
      "metadata": {
        "meta": "metaID"
      },
      "requireSignedURLs": true,
      "variants": {
        "thumbnail": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/thumbnail",
        "hero": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/hero",
        "original": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/original"
      },
      "uploaded": "2014-01-02T02:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-update-image
                                                                                                                                                                                                                                                                                                                                            PATCH Update image 
                                                                                                                                                                                                                                                                                                                                            Update image access control. On access control change, all copies of the image are purged from Cache.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            PATCH accounts/:account_identifier/images/v1/:identifier
                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                            requireSignedURLs
                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                            Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1/ZxR0pLaXRldlBtaFhhO2FiZGVnaA" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"requireSignedURLs":true}'
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ZxR0pLaXRldlBtaFhhO2FiZGVnaA",
    "filename": "avatar.png",
    "metadata": {
      "meta": "metaID"
    },
    "requireSignedURLs": true,
    "variants": {
      "thumbnail": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/thumbnail",
      "hero": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/hero",
      "original": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/original"
    },
    "uploaded": "2014-01-02T02:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-create-authenticated-direct-upload-url
                                                                                                                                                                                                                                                                                                                                            POST Create authenticated direct upload URL 
                                                                                                                                                                                                                                                                                                                                            Direct uploads allow users to upload images without API keys. A common place to use direct uploads is on web apps, client side applications, or on mobile devices where users upload content directly to Cloudflare Images.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            POST accounts/:account_identifier/images/v1/direct_upload
                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                            expiry
                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                            The date after upload will not be accepted. minimum: Now + 2 minutes. maximum: Now + 6 hours.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            "2021-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                                            • default value: Now + 30 minutes
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1/direct_upload" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"expiry":"2021-01-02T02:20:00Z"}'
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "uploadURL": "https://upload.imagedelivery.net/fgr33htrthytjtyereifjewoi338272s7w1383",
    "id": "ZxR0pLaXRldlBtaFhhO2FiZGVnaA"
  }
}
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-list-images
                                                                                                                                                                                                                                                                                                                                            GET List images 
                                                                                                                                                                                                                                                                                                                                            Up to 100 images can be listed with one request, use optional parameters below to get a specific range of images.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/images/v1
                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                            page
                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                            Page number of paginated results
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            1
                                                                                                                                                                                                                                                                                                                                            • default value: 1
                                                                                                                                                                                                                                                                                                                                            • min value:1
                                                                                                                                                                                                                                                                                                                                            per_page
                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                            Number of items per page
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            50
                                                                                                                                                                                                                                                                                                                                            • default value: 50
                                                                                                                                                                                                                                                                                                                                            • min value:10
                                                                                                                                                                                                                                                                                                                                            • max value:100
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1?page=1&per_page=50" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "ZxR0pLaXRldlBtaFhhO2FiZGVnaA",
      "filename": "avatar.png",
      "metadata": {
        "meta": "metaID"
      },
      "requireSignedURLs": true,
      "variants": {
        "thumbnail": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/thumbnail",
        "hero": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/hero",
        "original": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/original"
      },
      "uploaded": "2014-01-02T02:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-image-details
                                                                                                                                                                                                                                                                                                                                            GET Image details 
                                                                                                                                                                                                                                                                                                                                            Fetch details of a single image.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/images/v1/:identifier
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1/ZxR0pLaXRldlBtaFhhO2FiZGVnaA" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ZxR0pLaXRldlBtaFhhO2FiZGVnaA",
    "filename": "avatar.png",
    "metadata": {
      "meta": "metaID"
    },
    "requireSignedURLs": true,
    "variants": {
      "thumbnail": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/thumbnail",
      "hero": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/hero",
      "original": "https://imagedelivery.net/MTt4OTd0b0w5aj/ZxR0pLaXRldlBtaFhhO2FiZGVnaA/original"
    },
    "uploaded": "2014-01-02T02:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-delete-image
                                                                                                                                                                                                                                                                                                                                            DELETE Delete image 
                                                                                                                                                                                                                                                                                                                                            Delete a image on Cloudflare Images. On success, all copies of the image are deleted and purged from Cache.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_identifier/images/v1/:identifier
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1/ZxR0pLaXRldlBtaFhhO2FiZGVnaA" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-images-usage-statistics
                                                                                                                                                                                                                                                                                                                                            GET Images usage statistics 
                                                                                                                                                                                                                                                                                                                                            Fetch details of Cloudflare Images usage statistics
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/images/v1/stats
                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/023e105f4ecef8ad9ca31a8372d0c353/images/v1/stats" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                            {
  "count": {
    "current": 1000,
    "allowed": 100000
  }
}
                                                                                                                                                                                                                                                                                                                                            Cloudflare Images error codes
                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                            5400Bad Request
                                                                                                                                                                                                                                                                                                                                            5401Variant <name> not found
                                                                                                                                                                                                                                                                                                                                            5403The given account is not valid or is not authorized to access this service
                                                                                                                                                                                                                                                                                                                                            5404Image not found
                                                                                                                                                                                                                                                                                                                                            5408Client was sending upload too slowly
                                                                                                                                                                                                                                                                                                                                            5413Maximum image size of 10 Mb is reached
                                                                                                                                                                                                                                                                                                                                            5415Images must be uploaded as a form, not as raw image data. Please use multipart/form-data format
                                                                                                                                                                                                                                                                                                                                            5433Request has been aborted by the client
                                                                                                                                                                                                                                                                                                                                            5450Error while receiving upload
                                                                                                                                                                                                                                                                                                                                            5453The given account has reached a service limit
                                                                                                                                                                                                                                                                                                                                            5455Unsupported image format
                                                                                                                                                                                                                                                                                                                                            5500Internal Server Error
                                                                                                                                                                                                                                                                                                                                            5503Server Unavailable
                                                                                                                                                                                                                                                                                                                                            5540Error received from the storage
                                                                                                                                                                                                                                                                                                                                            5541Error while purging cache
                                                                                                                                                                                                                                                                                                                                            5542Error while loading account
                                                                                                                                                                                                                                                                                                                                            5543Error during audit
                                                                                                                                                                                                                                                                                                                                            5544Error during abuse operation
                                                                                                                                                                                                                                                                                                                                            5550Internal Server Error
                                                                                                                                                                                                                                                                                                                                            Cloudflare Images Variants
                                                                                                                                                                                                                                                                                                                                            Cloudflare Images supports variants that specify how you would like to resize images for different use cases. You can configure up to 20 variants.
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-variants
                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                            cloudflare-images-variants-create-a-variant
                                                                                                                                                                                                                                                                                                                                            POST Create a variant 
                                                                                                                                                                                                                                                                                                                                            Specify a variant how you would like to resize images for different use cases.
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            POST accounts/:account_identifier/images/v1/variants
                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                            id
                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                            API item identifier tag
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            "name-of-the-variant"
                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                            options
                                                                                                                                                                                                                                                                                                                                            object
                                                                                                                                                                                                                                                                                                                                            Options how to resize images for different use cases
                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                            {
  "fit": "scale-down",
  "metadata": "none",
  "width": 1366,
  "height": 768
}
                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                              neverRequireSignedURLs
                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                              Indicates whether the variant can access an image without a signature regardless of image access control
                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/images/v1/variants" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"name-of-the-variant","options":{"fit":"scale-down","metadata":"none","width":1366,"height":768},"neverRequireSignedURLs":true}'
                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "name-of-the-variant",
    "options": {
      "fit": "scale-down",
      "metadata": "none",
      "width": 1366,
      "height": 768
    },
    "neverRequireSignedURLs": true
  }
}
                                                                                                                                                                                                                                                                                                                                              cloudflare-images-variants-list-variants
                                                                                                                                                                                                                                                                                                                                              GET List variants 
                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/images/v1/variants
                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/images/v1/variants" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                              {
  "variants": {
    "name-of-the-variant": {
      "id": "name-of-the-variant",
      "options": {
        "fit": "scale-down",
        "metadata": "none",
        "width": 1366,
        "height": 768
      },
      "neverRequireSignedURLs": true
    }
  }
}
                                                                                                                                                                                                                                                                                                                                              cloudflare-images-variants-variant-details
                                                                                                                                                                                                                                                                                                                                              GET Variant details 
                                                                                                                                                                                                                                                                                                                                              Fetch details of a single variant.
                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/images/v1/variants/:identifier
                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/images/v1/variants/name-of-the-variant" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                              {
  "variant": {
    "id": "name-of-the-variant",
    "options": {
      "fit": "scale-down",
      "metadata": "none",
      "width": 1366,
      "height": 768
    },
    "neverRequireSignedURLs": true
  }
}
                                                                                                                                                                                                                                                                                                                                              cloudflare-images-variants-update-a-variant
                                                                                                                                                                                                                                                                                                                                              PATCH Update a variant 
                                                                                                                                                                                                                                                                                                                                              Updating a variant purges cache for all images associated with the variant.
                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                              PATCH accounts/:account_identifier/images/v1/variants/:identifier
                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                              options
                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                              Options how to resize images for different use cases
                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                              {
  "fit": "scale-down",
  "metadata": "none",
  "width": 1366,
  "height": 768
}
                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                neverRequireSignedURLs
                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                Indicates whether the variant can access an image without a signature regardless of image access control
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/images/v1/variants/name-of-the-variant" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"options":{"fit":"scale-down","metadata":"none","width":1366,"height":768},"neverRequireSignedURLs":true}'
                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "name-of-the-variant",
    "options": {
      "fit": "scale-down",
      "metadata": "none",
      "width": 1366,
      "height": 768
    },
    "neverRequireSignedURLs": true
  }
}
                                                                                                                                                                                                                                                                                                                                                cloudflare-images-variants-delete-a-variant
                                                                                                                                                                                                                                                                                                                                                DELETE Delete a variant 
                                                                                                                                                                                                                                                                                                                                                Deleting a variant purges cache for all images associated with the variant.
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                DELETE accounts/:account_identifier/images/v1/variants/:identifier
                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/images/v1/variants/name-of-the-variant" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": ""
}
                                                                                                                                                                                                                                                                                                                                                Cloudflare Images Keys
                                                                                                                                                                                                                                                                                                                                                Keys are used to generate signature tokens required for accessing images marked private
                                                                                                                                                                                                                                                                                                                                                cloudflare-images-keys
                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                cloudflare-images-keys-list-signing-keys
                                                                                                                                                                                                                                                                                                                                                GET List Signing Keys 
                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/images/v1/keys
                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/images/v1/keys" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "name": "default",
      "value": "Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5="
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                Pages Project
                                                                                                                                                                                                                                                                                                                                                A Pages project represents a website deployed to Cloudflare's edge.
                                                                                                                                                                                                                                                                                                                                                For more detailed documentation on using the API for Pages see the Pages docs.
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                pages-project
                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                pages-project-get-projects
                                                                                                                                                                                                                                                                                                                                                GET Get projects 
                                                                                                                                                                                                                                                                                                                                                Fetch a list of all user projects
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_id/pages/projects
                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "NextJS Blog",
    "id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "created_on": "2017-01-01T00:00:00Z",
    "subdomain": "helloworld.pages.dev",
    "domains": [
      "customdomain.com",
      "customdomain.org"
    ],
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    },
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "deployment_configs": {
      "preview": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      },
      "production": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      }
    },
    "latest_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    },
    "canonical_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    }
  },
  "result_info": {
    "page": 1,
    "per_page": 100,
    "count": 1,
    "total_count": 1
  }
}
                                                                                                                                                                                                                                                                                                                                                pages-project-get-project
                                                                                                                                                                                                                                                                                                                                                GET Get project 
                                                                                                                                                                                                                                                                                                                                                Fetch a project by name
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_id/pages/projects/:project_name
                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "NextJS Blog",
    "id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "created_on": "2017-01-01T00:00:00Z",
    "subdomain": "helloworld.pages.dev",
    "domains": [
      "customdomain.com",
      "customdomain.org"
    ],
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    },
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "deployment_configs": {
      "preview": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      },
      "production": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      }
    },
    "latest_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    },
    "canonical_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    }
  },
  "result_info": {
    "page": 1,
    "per_page": 100,
    "count": 1,
    "total_count": 1
  }
}
                                                                                                                                                                                                                                                                                                                                                pages-project-delete-project
                                                                                                                                                                                                                                                                                                                                                DELETE Delete project 
                                                                                                                                                                                                                                                                                                                                                Destroy a project by name
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                DELETE accounts/:account_id/pages/projects/:project_name
                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                {
  "result": null,
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                pages-project-create-project
                                                                                                                                                                                                                                                                                                                                                POST Create project 
                                                                                                                                                                                                                                                                                                                                                Make a new project
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                POST accounts/:account_id/pages/projects
                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                subdomain
                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                The Cloudflare subdomain associated with the project
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                "helloworld.pages.dev"
                                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                Name of the project
                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                "NextJS Blog"
                                                                                                                                                                                                                                                                                                                                                  domains
                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                  A list of associated custom domains for the project
                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                  [
  "customdomain.com",
  "customdomain.org"
]
                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                  canonical_deployment
                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                  Most recent deployment to the repo
                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                  {
  "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
  "short_id": "f64788e9",
  "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
  "project_name": "ninjakittens",
  "environment": "preview",
  "url": "https://f64788e9.ninjakittens.pages.dev",
  "created_on": "2021-03-09T00:55:03.923456Z",
  "modified_on": "2021-03-09T00:58:59.045655",
  "aliases": [
    "https://branchname.projectname.pages.dev"
  ],
  "latest_stage": {
    "name": "deploy",
    "started_on": "2021-03-09T00:55:03.923456Z",
    "ended_on": "2021-03-09T00:58:59.045655",
    "status": "success"
  },
  "env_vars": {
    "BUILD_VERSION": {
      "value": "3.3"
    },
    "ENV": {
      "value": "STAGING"
    }
  },
  "deployment_trigger": {
    "type": "ad_hoc",
    "metadata": {
      "branch": "main",
      "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
      "commit_message": "Update index.html"
    }
  },
  "stages": [
    {
      "name": "queued",
      "started_on": "2021-06-03T15:38:15.608194Z",
      "ended_on": "2021-06-03T15:39:03.134378Z",
      "status": "active"
    },
    {
      "name": "initialize",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    },
    {
      "name": "clone_repo",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    },
    {
      "name": "build",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    },
    {
      "name": "deploy",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    }
  ],
  "build_config": {
    "build_command": "npm run build",
    "destination_dir": "build",
    "root_dir": "/",
    "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
    "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
  },
  "source": {
    "type": "github",
    "config": {
      "owner": "cloudflare",
      "repo_name": "ninjakittens",
      "production_branch": "main",
      "pr_comments_enabled": true,
      "deployments_enabled": true
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                  build_config
                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                  Configs for the project build process
                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                  {
  "build_command": "npm run build",
  "destination_dir": "build",
  "root_dir": "/",
  "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
  "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
}
                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                    created_on
                                                                                                                                                                                                                                                                                                                                                    string (date-time)
                                                                                                                                                                                                                                                                                                                                                    When the project was created
                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                    "2017-01-01T00:00:00Z"
                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                    deployment_configs
                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                    Configs for deployments in a project
                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                    {
  "preview": {
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      }
    }
  },
  "production": {
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                      source
                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                      Configs for the project source
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      {
  "type": "github",
  "config": {
    "owner": "cloudflare",
    "repo_name": "ninjakittens",
    "production_branch": "main",
    "pr_comments_enabled": true,
    "deployments_enabled": true
  }
}
                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                                      id
                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                      Id of the project
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      "7b162ea7-7367-4d67-bcde-1160995d5"
                                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                                      latest_deployment
                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                      Most recent deployment to the repo
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      {
  "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
  "short_id": "f64788e9",
  "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
  "project_name": "ninjakittens",
  "environment": "preview",
  "url": "https://f64788e9.ninjakittens.pages.dev",
  "created_on": "2021-03-09T00:55:03.923456Z",
  "modified_on": "2021-03-09T00:58:59.045655",
  "aliases": [
    "https://branchname.projectname.pages.dev"
  ],
  "latest_stage": {
    "name": "deploy",
    "started_on": "2021-03-09T00:55:03.923456Z",
    "ended_on": "2021-03-09T00:58:59.045655",
    "status": "success"
  },
  "env_vars": {
    "BUILD_VERSION": {
      "value": "3.3"
    },
    "ENV": {
      "value": "STAGING"
    }
  },
  "deployment_trigger": {
    "type": "ad_hoc",
    "metadata": {
      "branch": "main",
      "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
      "commit_message": "Update index.html"
    }
  },
  "stages": [
    {
      "name": "queued",
      "started_on": "2021-06-03T15:38:15.608194Z",
      "ended_on": "2021-06-03T15:39:03.134378Z",
      "status": "active"
    },
    {
      "name": "initialize",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    },
    {
      "name": "clone_repo",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    },
    {
      "name": "build",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    },
    {
      "name": "deploy",
      "started_on": null,
      "ended_on": null,
      "status": "idle"
    }
  ],
  "build_config": {
    "build_command": "npm run build",
    "destination_dir": "build",
    "root_dir": "/",
    "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
    "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
  },
  "source": {
    "type": "github",
    "config": {
      "owner": "cloudflare",
      "repo_name": "ninjakittens",
      "production_branch": "main",
      "pr_comments_enabled": true,
      "deployments_enabled": true
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"NextJS Blog","id":"7b162ea7-7367-4d67-bcde-1160995d5","created_on":"2017-01-01T00:00:00Z","subdomain":"helloworld.pages.dev","domains":["customdomain.com","customdomain.org"],"source":{"type":"github","config":{"owner":"cloudflare","repo_name":"ninjakittens","production_branch":"main","pr_comments_enabled":true,"deployments_enabled":true}},"build_config":{"build_command":"npm run build","destination_dir":"build","root_dir":"/","web_analytics_tag":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","web_analytics_token":"021e1057c18547eca7b79f2516f06o7x"},"deployment_configs":{"preview":{"env_vars":{"BUILD_VERSION":{"value":"3.3"}}},"production":{"env_vars":{"BUILD_VERSION":{"value":"3.3"}}}},"latest_deployment":{"id":"f64788e9-fccd-4d4a-a28a-cb84f88f6","short_id":"f64788e9","project_id":"7b162ea7-7367-4d67-bcde-1160995d5","project_name":"ninjakittens","environment":"preview","url":"https://f64788e9.ninjakittens.pages.dev","created_on":"2021-03-09T00:55:03.923456Z","modified_on":"2021-03-09T00:58:59.045655","aliases":["https://branchname.projectname.pages.dev"],"latest_stage":{"name":"deploy","started_on":"2021-03-09T00:55:03.923456Z","ended_on":"2021-03-09T00:58:59.045655","status":"success"},"env_vars":{"BUILD_VERSION":{"value":"3.3"},"ENV":{"value":"STAGING"}},"deployment_trigger":{"type":"ad_hoc","metadata":{"branch":"main","commit_hash":"ad9ccd918a81025731e10e40267e11273a263421","commit_message":"Update index.html"}},"stages":[{"name":"queued","started_on":"2021-06-03T15:38:15.608194Z","ended_on":"2021-06-03T15:39:03.134378Z","status":"active"},{"name":"initialize","started_on":null,"ended_on":null,"status":"idle"},{"name":"clone_repo","started_on":null,"ended_on":null,"status":"idle"},{"name":"build","started_on":null,"ended_on":null,"status":"idle"},{"name":"deploy","started_on":null,"ended_on":null,"status":"idle"}],"build_config":{"build_command":"npm run build","destination_dir":"build","root_dir":"/","web_analytics_tag":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","web_analytics_token":"021e1057c18547eca7b79f2516f06o7x"},"source":{"type":"github","config":{"owner":"cloudflare","repo_name":"ninjakittens","production_branch":"main","pr_comments_enabled":true,"deployments_enabled":true}}},"canonical_deployment":{"id":"f64788e9-fccd-4d4a-a28a-cb84f88f6","short_id":"f64788e9","project_id":"7b162ea7-7367-4d67-bcde-1160995d5","project_name":"ninjakittens","environment":"preview","url":"https://f64788e9.ninjakittens.pages.dev","created_on":"2021-03-09T00:55:03.923456Z","modified_on":"2021-03-09T00:58:59.045655","aliases":["https://branchname.projectname.pages.dev"],"latest_stage":{"name":"deploy","started_on":"2021-03-09T00:55:03.923456Z","ended_on":"2021-03-09T00:58:59.045655","status":"success"},"env_vars":{"BUILD_VERSION":{"value":"3.3"},"ENV":{"value":"STAGING"}},"deployment_trigger":{"type":"ad_hoc","metadata":{"branch":"main","commit_hash":"ad9ccd918a81025731e10e40267e11273a263421","commit_message":"Update index.html"}},"stages":[{"name":"queued","started_on":"2021-06-03T15:38:15.608194Z","ended_on":"2021-06-03T15:39:03.134378Z","status":"active"},{"name":"initialize","started_on":null,"ended_on":null,"status":"idle"},{"name":"clone_repo","started_on":null,"ended_on":null,"status":"idle"},{"name":"build","started_on":null,"ended_on":null,"status":"idle"},{"name":"deploy","started_on":null,"ended_on":null,"status":"idle"}],"build_config":{"build_command":"npm run build","destination_dir":"build","root_dir":"/","web_analytics_tag":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","web_analytics_token":"021e1057c18547eca7b79f2516f06o7x"},"source":{"type":"github","config":{"owner":"cloudflare","repo_name":"ninjakittens","production_branch":"main","pr_comments_enabled":true,"deployments_enabled":true}}}}'
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "NextJS Blog",
    "id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "created_on": "2017-01-01T00:00:00Z",
    "subdomain": "helloworld.pages.dev",
    "domains": [
      "customdomain.com",
      "customdomain.org"
    ],
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    },
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "deployment_configs": {
      "preview": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      },
      "production": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      }
    },
    "latest_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    },
    "canonical_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      pages-project-update-project
                                                                                                                                                                                                                                                                                                                                                      PATCH Update project 
                                                                                                                                                                                                                                                                                                                                                      Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      PATCH accounts/:account_id/pages/projects/:project_name
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"deployment_configs":{"production":{"env_vars":{"delete_this_env_var":null,"BUILD_VERSION":{"value":"3.3"}}}}}'
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "NextJS Blog",
    "id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "created_on": "2017-01-01T00:00:00Z",
    "subdomain": "helloworld.pages.dev",
    "domains": [
      "customdomain.com",
      "customdomain.org"
    ],
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    },
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "deployment_configs": {
      "preview": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      },
      "production": {
        "env_vars": {
          "BUILD_VERSION": {
            "value": "3.3"
          }
        }
      }
    },
    "latest_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    },
    "canonical_deployment": {
      "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
      "short_id": "f64788e9",
      "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
      "project_name": "ninjakittens",
      "environment": "preview",
      "url": "https://f64788e9.ninjakittens.pages.dev",
      "created_on": "2021-03-09T00:55:03.923456Z",
      "modified_on": "2021-03-09T00:58:59.045655",
      "aliases": [
        "https://branchname.projectname.pages.dev"
      ],
      "latest_stage": {
        "name": "deploy",
        "started_on": "2021-03-09T00:55:03.923456Z",
        "ended_on": "2021-03-09T00:58:59.045655",
        "status": "success"
      },
      "env_vars": {
        "BUILD_VERSION": {
          "value": "3.3"
        },
        "ENV": {
          "value": "STAGING"
        }
      },
      "deployment_trigger": {
        "type": "ad_hoc",
        "metadata": {
          "branch": "main",
          "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
          "commit_message": "Update index.html"
        }
      },
      "stages": [
        {
          "name": "queued",
          "started_on": "2021-06-03T15:38:15.608194Z",
          "ended_on": "2021-06-03T15:39:03.134378Z",
          "status": "active"
        },
        {
          "name": "initialize",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "clone_repo",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "build",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        },
        {
          "name": "deploy",
          "started_on": null,
          "ended_on": null,
          "status": "idle"
        }
      ],
      "build_config": {
        "build_command": "npm run build",
        "destination_dir": "build",
        "root_dir": "/",
        "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
        "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
      },
      "source": {
        "type": "github",
        "config": {
          "owner": "cloudflare",
          "repo_name": "ninjakittens",
          "production_branch": "main",
          "pr_comments_enabled": true,
          "deployments_enabled": true
        }
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      Pages Project error codes
                                                                                                                                                                                                                                                                                                                                                      CodeDescription
                                                                                                                                                                                                                                                                                                                                                      8000000An unknown error occurred
                                                                                                                                                                                                                                                                                                                                                      8000001A project already exists for this repo
                                                                                                                                                                                                                                                                                                                                                      8000002A project with this name already exists
                                                                                                                                                                                                                                                                                                                                                      8000003Invalid project name
                                                                                                                                                                                                                                                                                                                                                      8000004Account not authorized for the requested repo
                                                                                                                                                                                                                                                                                                                                                      8000005Required field missing
                                                                                                                                                                                                                                                                                                                                                      8000006Unable to parse request
                                                                                                                                                                                                                                                                                                                                                      8000007Project not found
                                                                                                                                                                                                                                                                                                                                                      8000008No installation found
                                                                                                                                                                                                                                                                                                                                                      8000009Deployment not found
                                                                                                                                                                                                                                                                                                                                                      8000010User is not authorized for provided GitHub Installation ID
                                                                                                                                                                                                                                                                                                                                                      8000011User has no linked GitHub accounts matching the provided username
                                                                                                                                                                                                                                                                                                                                                      8000012User has no linked GitHub repositories matching the provided name
                                                                                                                                                                                                                                                                                                                                                      8000013Authorization failed
                                                                                                                                                                                                                                                                                                                                                      8000014Deployment type not found
                                                                                                                                                                                                                                                                                                                                                      8000015Domain is invalid
                                                                                                                                                                                                                                                                                                                                                      8000016Unicode domains are not supported
                                                                                                                                                                                                                                                                                                                                                      8000017An operation is already in progress for this domain
                                                                                                                                                                                                                                                                                                                                                      8000018Domain is unavailable
                                                                                                                                                                                                                                                                                                                                                      8000019Project has reached the maximum number of allowed domains
                                                                                                                                                                                                                                                                                                                                                      8000020No deployment stage found for the provided name
                                                                                                                                                                                                                                                                                                                                                      8000021Domain not found
                                                                                                                                                                                                                                                                                                                                                      8000022Invalid PATCH operation requested
                                                                                                                                                                                                                                                                                                                                                      8000023Attempt to add duplicate environment variable, or replace or delete nonexistent variable
                                                                                                                                                                                                                                                                                                                                                      8000024Invalid list options provided
                                                                                                                                                                                                                                                                                                                                                      8000025Domain is not registered
                                                                                                                                                                                                                                                                                                                                                      8000026Coming soon
                                                                                                                                                                                                                                                                                                                                                      8000027Too many projects
                                                                                                                                                                                                                                                                                                                                                      8000028Must delete custom domains before deleting project
                                                                                                                                                                                                                                                                                                                                                      8000029Subdomain is unavailable
                                                                                                                                                                                                                                                                                                                                                      8000030Subdomain is blocked
                                                                                                                                                                                                                                                                                                                                                      8000031Unable to cancel completed deployment
                                                                                                                                                                                                                                                                                                                                                      8000032Unable to find a branch with the provided name
                                                                                                                                                                                                                                                                                                                                                      8000033Production branch must be set
                                                                                                                                                                                                                                                                                                                                                      8000034Cannot delete active production deployment
                                                                                                                                                                                                                                                                                                                                                      8000035Cannot delete aliased deployment
                                                                                                                                                                                                                                                                                                                                                      8000036Account has been blocked
                                                                                                                                                                                                                                                                                                                                                      Pages Deployment
                                                                                                                                                                                                                                                                                                                                                      A Pages deployment is a published build for a commit on Pages
                                                                                                                                                                                                                                                                                                                                                      For more detailed documentation on using the API for Pages see the Pages docs.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      pages-deployment
                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-get-deployments
                                                                                                                                                                                                                                                                                                                                                      GET Get deployments 
                                                                                                                                                                                                                                                                                                                                                      Fetch a list of deployments from a project
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_id/pages/projects/:project_name/deployments
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
    "short_id": "f64788e9",
    "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "project_name": "ninjakittens",
    "environment": "preview",
    "url": "https://f64788e9.ninjakittens.pages.dev",
    "created_on": "2021-03-09T00:55:03.923456Z",
    "modified_on": "2021-03-09T00:58:59.045655",
    "aliases": [
      "https://branchname.projectname.pages.dev"
    ],
    "latest_stage": {
      "name": "deploy",
      "started_on": "2021-03-09T00:55:03.923456Z",
      "ended_on": "2021-03-09T00:58:59.045655",
      "status": "success"
    },
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      },
      "ENV": {
        "value": "STAGING"
      }
    },
    "deployment_trigger": {
      "type": "ad_hoc",
      "metadata": {
        "branch": "main",
        "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
        "commit_message": "Update index.html"
      }
    },
    "stages": [
      {
        "name": "queued",
        "started_on": "2021-06-03T15:38:15.608194Z",
        "ended_on": "2021-06-03T15:39:03.134378Z",
        "status": "active"
      },
      {
        "name": "initialize",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "clone_repo",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "build",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "deploy",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      }
    ],
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-get-deployment-info
                                                                                                                                                                                                                                                                                                                                                      GET Get deployment info 
                                                                                                                                                                                                                                                                                                                                                      Fetch a deployment
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
    "short_id": "f64788e9",
    "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "project_name": "ninjakittens",
    "environment": "preview",
    "url": "https://f64788e9.ninjakittens.pages.dev",
    "created_on": "2021-03-09T00:55:03.923456Z",
    "modified_on": "2021-03-09T00:58:59.045655",
    "aliases": [
      "https://branchname.projectname.pages.dev"
    ],
    "latest_stage": {
      "name": "deploy",
      "started_on": "2021-03-09T00:55:03.923456Z",
      "ended_on": "2021-03-09T00:58:59.045655",
      "status": "success"
    },
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      },
      "ENV": {
        "value": "STAGING"
      }
    },
    "deployment_trigger": {
      "type": "ad_hoc",
      "metadata": {
        "branch": "main",
        "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
        "commit_message": "Update index.html"
      }
    },
    "stages": [
      {
        "name": "queued",
        "started_on": "2021-06-03T15:38:15.608194Z",
        "ended_on": "2021-06-03T15:39:03.134378Z",
        "status": "active"
      },
      {
        "name": "initialize",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "clone_repo",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "build",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "deploy",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      }
    ],
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-get-deployment-stage-logs
                                                                                                                                                                                                                                                                                                                                                      GET Get deployment stage logs 
                                                                                                                                                                                                                                                                                                                                                      Fetch deploy logs
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/history/:deployment_stage_name/logs
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/history/:deployment_stage_name/logs" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "build",
    "started_on": "2021-04-20T19:35:58.238757Z",
    "ended_on": "2021-04-20T19:36:06.38889Z",
    "status": "success",
    "start": 0,
    "end": 37,
    "total": 37,
    "data": [
      {
        "id": 15,
        "timestamp": "2021-04-20T19:35:59.0749819Z",
        "message": "Installing dependencies"
      },
      {
        "id": 16,
        "timestamp": "2021-04-20T19:35:59.0931208Z",
        "message": "Python version set to 2.7"
      },
      {
        "id": 17,
        "timestamp": "2021-04-20T19:36:02.2369501Z",
        "message": "v12.18.0 is already installed."
      },
      {
        "id": 18,
        "timestamp": "2021-04-20T19:36:02.6028886Z",
        "message": "Now using node v12.18.0 (npm v6.14.4)"
      },
      {
        "id": 19,
        "timestamp": "2021-04-20T19:36:02.624555Z",
        "message": "Started restoring cached build plugins"
      },
      {
        "id": 20,
        "timestamp": "2021-04-20T19:36:02.6340688Z",
        "message": "Finished restoring cached build plugins"
      },
      {
        "id": 21,
        "timestamp": "2021-04-20T19:36:02.963095Z",
        "message": "Attempting ruby version 2.7.1, read from environment"
      },
      {
        "id": 22,
        "timestamp": "2021-04-20T19:36:04.2236084Z",
        "message": "Using ruby version 2.7.1"
      },
      {
        "id": 23,
        "timestamp": "2021-04-20T19:36:04.5450152Z",
        "message": "Using PHP version 5.6"
      },
      {
        "id": 24,
        "timestamp": "2021-04-20T19:36:04.5740509Z",
        "message": "5.2 is already installed."
      },
      {
        "id": 25,
        "timestamp": "2021-04-20T19:36:04.577035Z",
        "message": "Using Swift version 5.2"
      },
      {
        "id": 26,
        "timestamp": "2021-04-20T19:36:04.5771615Z",
        "message": "Installing Hugo 0.54.0"
      },
      {
        "id": 27,
        "timestamp": "2021-04-20T19:36:05.4786868Z",
        "message": "Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z"
      },
      {
        "id": 28,
        "timestamp": "2021-04-20T19:36:05.4794366Z",
        "message": "Started restoring cached go cache"
      },
      {
        "id": 29,
        "timestamp": "2021-04-20T19:36:05.481977Z",
        "message": "Finished restoring cached go cache"
      },
      {
        "id": 30,
        "timestamp": "2021-04-20T19:36:05.9049776Z",
        "message": "go version go1.14.4 linux/amd64"
      },
      {
        "id": 31,
        "timestamp": "2021-04-20T19:36:05.9086053Z",
        "message": "go version go1.14.4 linux/amd64"
      },
      {
        "id": 32,
        "timestamp": "2021-04-20T19:36:05.9163568Z",
        "message": "Installing missing commands"
      },
      {
        "id": 33,
        "timestamp": "2021-04-20T19:36:05.9163934Z",
        "message": "Verify run directory"
      },
      {
        "id": 34,
        "timestamp": "2021-04-20T19:36:05.9164636Z",
        "message": "Executing user command: echo \"skipping build step: no build command specified\""
      },
      {
        "id": 35,
        "timestamp": "2021-04-20T19:36:05.9165087Z",
        "message": "skipping build step: no build command specified"
      },
      {
        "id": 36,
        "timestamp": "2021-04-20T19:36:05.917412Z",
        "message": "Finished"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-delete-deployment
                                                                                                                                                                                                                                                                                                                                                      DELETE Delete deployment 
                                                                                                                                                                                                                                                                                                                                                      Destroy a deployment
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      DELETE accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "result": null,
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-create-deployment
                                                                                                                                                                                                                                                                                                                                                      POST Create deployment 
                                                                                                                                                                                                                                                                                                                                                      Start a new deployment from production. The repo/account must have been authorized through the Pages UI dash before.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      POST accounts/:account_id/pages/projects/:project_name/deployments
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
    "short_id": "f64788e9",
    "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "project_name": "ninjakittens",
    "environment": "preview",
    "url": "https://f64788e9.ninjakittens.pages.dev",
    "created_on": "2021-03-09T00:55:03.923456Z",
    "modified_on": "2021-03-09T00:58:59.045655",
    "aliases": [
      "https://branchname.projectname.pages.dev"
    ],
    "latest_stage": {
      "name": "deploy",
      "started_on": "2021-03-09T00:55:03.923456Z",
      "ended_on": "2021-03-09T00:58:59.045655",
      "status": "success"
    },
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      },
      "ENV": {
        "value": "STAGING"
      }
    },
    "deployment_trigger": {
      "type": "ad_hoc",
      "metadata": {
        "branch": "main",
        "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
        "commit_message": "Update index.html"
      }
    },
    "stages": [
      {
        "name": "queued",
        "started_on": "2021-06-03T15:38:15.608194Z",
        "ended_on": "2021-06-03T15:39:03.134378Z",
        "status": "active"
      },
      {
        "name": "initialize",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "clone_repo",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "build",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "deploy",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      }
    ],
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-retry-deployment
                                                                                                                                                                                                                                                                                                                                                      POST Retry deployment 
                                                                                                                                                                                                                                                                                                                                                      Retry a previous deployment
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      POST accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/retry
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/retry" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
    "short_id": "f64788e9",
    "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "project_name": "ninjakittens",
    "environment": "preview",
    "url": "https://f64788e9.ninjakittens.pages.dev",
    "created_on": "2021-03-09T00:55:03.923456Z",
    "modified_on": "2021-03-09T00:58:59.045655",
    "aliases": [
      "https://branchname.projectname.pages.dev"
    ],
    "latest_stage": {
      "name": "deploy",
      "started_on": "2021-03-09T00:55:03.923456Z",
      "ended_on": "2021-03-09T00:58:59.045655",
      "status": "success"
    },
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      },
      "ENV": {
        "value": "STAGING"
      }
    },
    "deployment_trigger": {
      "type": "ad_hoc",
      "metadata": {
        "branch": "main",
        "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
        "commit_message": "Update index.html"
      }
    },
    "stages": [
      {
        "name": "queued",
        "started_on": "2021-06-03T15:38:15.608194Z",
        "ended_on": "2021-06-03T15:39:03.134378Z",
        "status": "active"
      },
      {
        "name": "initialize",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "clone_repo",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "build",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "deploy",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      }
    ],
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      pages-deployment-rollback-deployment
                                                                                                                                                                                                                                                                                                                                                      POST Rollback deployment 
                                                                                                                                                                                                                                                                                                                                                      Rollback the production deployment to a previous deploy. You can only rollback to succesful builds on production.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      POST accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/rollback
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/deployments/:deployment_id/rollback" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
    "short_id": "f64788e9",
    "project_id": "7b162ea7-7367-4d67-bcde-1160995d5",
    "project_name": "ninjakittens",
    "environment": "preview",
    "url": "https://f64788e9.ninjakittens.pages.dev",
    "created_on": "2021-03-09T00:55:03.923456Z",
    "modified_on": "2021-03-09T00:58:59.045655",
    "aliases": [
      "https://branchname.projectname.pages.dev"
    ],
    "latest_stage": {
      "name": "deploy",
      "started_on": "2021-03-09T00:55:03.923456Z",
      "ended_on": "2021-03-09T00:58:59.045655",
      "status": "success"
    },
    "env_vars": {
      "BUILD_VERSION": {
        "value": "3.3"
      },
      "ENV": {
        "value": "STAGING"
      }
    },
    "deployment_trigger": {
      "type": "ad_hoc",
      "metadata": {
        "branch": "main",
        "commit_hash": "ad9ccd918a81025731e10e40267e11273a263421",
        "commit_message": "Update index.html"
      }
    },
    "stages": [
      {
        "name": "queued",
        "started_on": "2021-06-03T15:38:15.608194Z",
        "ended_on": "2021-06-03T15:39:03.134378Z",
        "status": "active"
      },
      {
        "name": "initialize",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "clone_repo",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "build",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      },
      {
        "name": "deploy",
        "started_on": null,
        "ended_on": null,
        "status": "idle"
      }
    ],
    "build_config": {
      "build_command": "npm run build",
      "destination_dir": "build",
      "root_dir": "/",
      "web_analytics_tag": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
      "web_analytics_token": "021e1057c18547eca7b79f2516f06o7x"
    },
    "source": {
      "type": "github",
      "config": {
        "owner": "cloudflare",
        "repo_name": "ninjakittens",
        "production_branch": "main",
        "pr_comments_enabled": true,
        "deployments_enabled": true
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                      Pages Deployment error codes
                                                                                                                                                                                                                                                                                                                                                      CodeDescription
                                                                                                                                                                                                                                                                                                                                                      8000000An unknown error occurred
                                                                                                                                                                                                                                                                                                                                                      8000001A project already exists for this repo
                                                                                                                                                                                                                                                                                                                                                      8000002A project with this name already exists
                                                                                                                                                                                                                                                                                                                                                      8000003Invalid project name
                                                                                                                                                                                                                                                                                                                                                      8000004Account not authorized for the requested repo
                                                                                                                                                                                                                                                                                                                                                      8000005Required field missing
                                                                                                                                                                                                                                                                                                                                                      8000006Unable to parse request
                                                                                                                                                                                                                                                                                                                                                      8000007Project not found
                                                                                                                                                                                                                                                                                                                                                      8000008No installation found
                                                                                                                                                                                                                                                                                                                                                      8000009Deployment not found
                                                                                                                                                                                                                                                                                                                                                      8000010User is not authorized for provided GitHub Installation ID
                                                                                                                                                                                                                                                                                                                                                      8000011User has no linked GitHub accounts matching the provided username
                                                                                                                                                                                                                                                                                                                                                      8000012User has no linked GitHub repositories matching the provided name
                                                                                                                                                                                                                                                                                                                                                      8000013Authorization failed
                                                                                                                                                                                                                                                                                                                                                      8000014Deployment type not found
                                                                                                                                                                                                                                                                                                                                                      8000015Domain is invalid
                                                                                                                                                                                                                                                                                                                                                      8000016Unicode domains are not supported
                                                                                                                                                                                                                                                                                                                                                      8000017An operation is already in progress for this domain
                                                                                                                                                                                                                                                                                                                                                      8000018Domain is unavailable
                                                                                                                                                                                                                                                                                                                                                      8000019Project has reached the maximum number of allowed domains
                                                                                                                                                                                                                                                                                                                                                      8000020No deployment stage found for the provided name
                                                                                                                                                                                                                                                                                                                                                      8000021Domain not found
                                                                                                                                                                                                                                                                                                                                                      8000022Invalid PATCH operation requested
                                                                                                                                                                                                                                                                                                                                                      8000023Attempt to add duplicate environment variable, or replace or delete nonexistent variable
                                                                                                                                                                                                                                                                                                                                                      8000024Invalid list options provided
                                                                                                                                                                                                                                                                                                                                                      8000025Domain is not registered
                                                                                                                                                                                                                                                                                                                                                      8000026Coming soon
                                                                                                                                                                                                                                                                                                                                                      8000027Too many projects
                                                                                                                                                                                                                                                                                                                                                      8000028Must delete custom domains before deleting project
                                                                                                                                                                                                                                                                                                                                                      8000029Subdomain is unavailable
                                                                                                                                                                                                                                                                                                                                                      8000030Subdomain is blocked
                                                                                                                                                                                                                                                                                                                                                      8000031Unable to cancel completed deployment
                                                                                                                                                                                                                                                                                                                                                      8000032Unable to find a branch with the provided name
                                                                                                                                                                                                                                                                                                                                                      8000033Production branch must be set
                                                                                                                                                                                                                                                                                                                                                      8000034Cannot delete active production deployment
                                                                                                                                                                                                                                                                                                                                                      8000035Cannot delete aliased deployment
                                                                                                                                                                                                                                                                                                                                                      8000036Account has been blocked
                                                                                                                                                                                                                                                                                                                                                      Pages Domains
                                                                                                                                                                                                                                                                                                                                                      A domain represents a custom domain tied to a Pages project.
                                                                                                                                                                                                                                                                                                                                                      For more detailed documentation on using the API for Pages see the Pages docs.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      pages-domains
                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                      pages-domains-get-domains
                                                                                                                                                                                                                                                                                                                                                      GET Get domains 
                                                                                                                                                                                                                                                                                                                                                      Fetch a list of all domains
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_id/pages/projects/:project_name/domains
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "8232210c-6818-4e34-8d95-cc386874b8d2",
      "name": "helloworld.com",
      "status": "pending",
      "verification_data": {
        "status": "active"
      },
      "validation_data": {
        "status": "active",
        "method": "http"
      },
      "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353",
      "created_on": "2017-01-01T00:00:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                      pages-domains-get-domain
                                                                                                                                                                                                                                                                                                                                                      GET Get domain 
                                                                                                                                                                                                                                                                                                                                                      Fetch a single domain
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_id/pages/projects/:project_name/domains/:domain_name
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/:account_id/pages/projects/:project_name/domains/:domain_name" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "8232210c-6818-4e34-8d95-cc386874b8d2",
    "name": "helloworld.com",
    "status": "pending",
    "verification_data": {
      "status": "active"
    },
    "validation_data": {
      "status": "active",
      "method": "http"
    },
    "zone_tag": "023e105f4ecef8ad9ca31a8372d0c353",
    "created_on": "2017-01-01T00:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                      Pages Domains error codes
                                                                                                                                                                                                                                                                                                                                                      CodeDescription
                                                                                                                                                                                                                                                                                                                                                      8000000An unknown error occurred
                                                                                                                                                                                                                                                                                                                                                      8000001A project already exists for this repo
                                                                                                                                                                                                                                                                                                                                                      8000002A project with this name already exists
                                                                                                                                                                                                                                                                                                                                                      8000003Invalid project name
                                                                                                                                                                                                                                                                                                                                                      8000004Account not authorized for the requested repo
                                                                                                                                                                                                                                                                                                                                                      8000005Required field missing
                                                                                                                                                                                                                                                                                                                                                      8000006Unable to parse request
                                                                                                                                                                                                                                                                                                                                                      8000007Project not found
                                                                                                                                                                                                                                                                                                                                                      8000008No installation found
                                                                                                                                                                                                                                                                                                                                                      8000009Deployment not found
                                                                                                                                                                                                                                                                                                                                                      8000010User is not authorized for provided GitHub Installation ID
                                                                                                                                                                                                                                                                                                                                                      8000011User has no linked GitHub accounts matching the provided username
                                                                                                                                                                                                                                                                                                                                                      8000012User has no linked GitHub repositories matching the provided name
                                                                                                                                                                                                                                                                                                                                                      8000013Authorization failed
                                                                                                                                                                                                                                                                                                                                                      8000014Deployment type not found
                                                                                                                                                                                                                                                                                                                                                      8000015Domain is invalid
                                                                                                                                                                                                                                                                                                                                                      8000016Unicode domains are not supported
                                                                                                                                                                                                                                                                                                                                                      8000017An operation is already in progress for this domain
                                                                                                                                                                                                                                                                                                                                                      8000018Domain is unavailable
                                                                                                                                                                                                                                                                                                                                                      8000019Project has reached the maximum number of allowed domains
                                                                                                                                                                                                                                                                                                                                                      8000020No deployment stage found for the provided name
                                                                                                                                                                                                                                                                                                                                                      8000021Domain not found
                                                                                                                                                                                                                                                                                                                                                      8000022Invalid PATCH operation requested
                                                                                                                                                                                                                                                                                                                                                      8000023Attempt to add duplicate environment variable, or replace or delete nonexistent variable
                                                                                                                                                                                                                                                                                                                                                      8000024Invalid list options provided
                                                                                                                                                                                                                                                                                                                                                      8000025Domain is not registered
                                                                                                                                                                                                                                                                                                                                                      8000026Coming soon
                                                                                                                                                                                                                                                                                                                                                      8000027Too many projects
                                                                                                                                                                                                                                                                                                                                                      8000028Must delete custom domains before deleting project
                                                                                                                                                                                                                                                                                                                                                      8000029Subdomain is unavailable
                                                                                                                                                                                                                                                                                                                                                      8000030Subdomain is blocked
                                                                                                                                                                                                                                                                                                                                                      8000031Unable to cancel completed deployment
                                                                                                                                                                                                                                                                                                                                                      8000032Unable to find a branch with the provided name
                                                                                                                                                                                                                                                                                                                                                      8000033Production branch must be set
                                                                                                                                                                                                                                                                                                                                                      8000034Cannot delete active production deployment
                                                                                                                                                                                                                                                                                                                                                      8000035Cannot delete aliased deployment
                                                                                                                                                                                                                                                                                                                                                      8000036Account has been blocked
                                                                                                                                                                                                                                                                                                                                                      Worker Script
                                                                                                                                                                                                                                                                                                                                                      A Worker script is a single script that is executed on matching routes in the Cloudflare edge
                                                                                                                                                                                                                                                                                                                                                      For more detailed documentation on using the API for Workers see the Workers API.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      worker-script
                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                      worker-script-upload-worker
                                                                                                                                                                                                                                                                                                                                                      PUT Upload Worker permission needed: com.cloudflare.edge.worker.script.create
                                                                                                                                                                                                                                                                                                                                                      Upload a worker, or a new version of a worker.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      PUT accounts/:account_identifier/workers/scripts/:script_name
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/javascript" \
--data "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "script": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })",
    "etag": "ea95132c15732412d22c1476fa83f27a",
    "size": 1024,
    "usage_model": "unbound",
    "modified_on": "2017-01-01T00:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                      worker-script-list-workers
                                                                                                                                                                                                                                                                                                                                                      GET List Workers permission needed: com.cloudflare.edge.worker.script.list
                                                                                                                                                                                                                                                                                                                                                      Fetch a list of uploaded workers.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_identifier/workers/scripts
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "this-is_my_script-01",
      "etag": "ea95132c15732412d22c1476fa83f27a",
      "usage_model": "unbound",
      "created_on": "2017-01-01T00:00:00Z",
      "modified_on": "2017-01-01T00:00:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                      worker-script-download-worker
                                                                                                                                                                                                                                                                                                                                                      GET Download Worker permission needed: com.cloudflare.edge.worker.script.read
                                                                                                                                                                                                                                                                                                                                                      Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_identifier/workers/scripts/:script_name
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Accept: application/javascript"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
                                                                                                                                                                                                                                                                                                                                                      worker-script-delete-worker
                                                                                                                                                                                                                                                                                                                                                      DELETE Delete Worker permission needed: com.cloudflare.edge.worker.script.delete
                                                                                                                                                                                                                                                                                                                                                      Delete your worker. This call has no response body on a successful delete.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      DELETE accounts/:account_identifier/workers/scripts/:script_name
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      worker-script-update-usage-model
                                                                                                                                                                                                                                                                                                                                                      PUT Update Usage Model permission needed: com.cloudflare.edge.worker.script.create
                                                                                                                                                                                                                                                                                                                                                      Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      PUT accounts/:account_identifier/workers/scripts/:script_name/usage-model
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/usage-model" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     --data '"{'usage_model': 'unbound'}"'
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "usage_model": "unbound"
  }
}
                                                                                                                                                                                                                                                                                                                                                      worker-script-fetch-usage-model
                                                                                                                                                                                                                                                                                                                                                      GET Fetch Usage Model permission needed: com.cloudflare.edge.worker.script.read
                                                                                                                                                                                                                                                                                                                                                      Fetches the Usage Model for a given Worker.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_identifier/workers/scripts/:script_name/usage-model
                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/usage-model" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "usage_model": "unbound"
  }
}
                                                                                                                                                                                                                                                                                                                                                      Worker Script error codes
                                                                                                                                                                                                                                                                                                                                                      CodeDescription
                                                                                                                                                                                                                                                                                                                                                      10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                      10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                      10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                      10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                      10006Unparseable script body
                                                                                                                                                                                                                                                                                                                                                      10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                      10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                      10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                      10018Attempted to update a script where the e-tag does not match
                                                                                                                                                                                                                                                                                                                                                      10021Script content failed validation checks, but was otherwise parseable
                                                                                                                                                                                                                                                                                                                                                      10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                      10027Script body was too large
                                                                                                                                                                                                                                                                                                                                                      10075Requires a Workers Paid plan
                                                                                                                                                                                                                                                                                                                                                      Worker Routes
                                                                                                                                                                                                                                                                                                                                                      Routes are basic patterns used to enable or disable workers that match requests.
                                                                                                                                                                                                                                                                                                                                                      For more detailed documentation on using the API for Workers see the Workers API.
                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                      worker-routes
                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                      worker-routes-create-route
                                                                                                                                                                                                                                                                                                                                                      POST Create Route permission needed: com.cloudflare.edge.worker.route.create
                                                                                                                                                                                                                                                                                                                                                      POST zones/:zone_id/workers/routes
                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                      pattern
                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                      "example.net/*"
                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                        script
                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                        Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                        "this-is_my_script-01"
                                                                                                                                                                                                                                                                                                                                                        • pattern: ^[a-z0-9_][a-z0-9-_]*$
                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"pattern":"example.net/*","script":"this-is_my_script-01"}'
                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                        worker-routes-list-routes
                                                                                                                                                                                                                                                                                                                                                        GET List Routes permission needed: com.cloudflare.edge.worker.route.list
                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_id/workers/routes
                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "9a7806061c88ada191ed06f989cc3dac",
      "pattern": "example.net/*",
      "script": "this-is_my_script-01"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                        worker-routes-get-route
                                                                                                                                                                                                                                                                                                                                                        GET Get Route permission needed: com.cloudflare.edge.worker.route.read
                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_id/workers/routes/:route_id
                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "pattern": "example.net/*",
    "script": "this-is_my_script-01"
  }
}
                                                                                                                                                                                                                                                                                                                                                        worker-routes-update-route
                                                                                                                                                                                                                                                                                                                                                        PUT Update Route permission needed: com.cloudflare.edge.worker.route.update
                                                                                                                                                                                                                                                                                                                                                        PUT zones/:zone_id/workers/routes/:route_id
                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                        pattern
                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                        "example.net/*"
                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                          script
                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                          Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          "this-is_my_script-01"
                                                                                                                                                                                                                                                                                                                                                          • pattern: ^[a-z0-9_][a-z0-9-_]*$
                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                          curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"pattern":"example.net/*","script":"this-is_my_script-01"}'
                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "pattern": "example.net/*",
    "script": "this-is_my_script-01"
  }
}
                                                                                                                                                                                                                                                                                                                                                          worker-routes-delete-route
                                                                                                                                                                                                                                                                                                                                                          DELETE Delete Route permission needed: com.cloudflare.edge.worker.route.delete
                                                                                                                                                                                                                                                                                                                                                          DELETE zones/:zone_id/workers/routes/:route_id
                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/routes/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                          Worker Routes error codes
                                                                                                                                                                                                                                                                                                                                                          CodeDescription
                                                                                                                                                                                                                                                                                                                                                          10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                          10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                          10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                          10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                          10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                          10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                          10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                          10020Attempted to create a route for a pattern that already exists
                                                                                                                                                                                                                                                                                                                                                          10022Route pattern was invalid
                                                                                                                                                                                                                                                                                                                                                          10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                          10026Route pattern was unparseable
                                                                                                                                                                                                                                                                                                                                                          Workers KV Namespace
                                                                                                                                                                                                                                                                                                                                                          A Namespace is a collection of key-value pairs stored in Workers KV.
                                                                                                                                                                                                                                                                                                                                                          workers-kv-namespace
                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                          workers-kv-namespace-list-namespaces
                                                                                                                                                                                                                                                                                                                                                          GET List Namespaces permission needed: com.cloudflare.edge.storage.kv.namespace.list
                                                                                                                                                                                                                                                                                                                                                          Returns the namespaces owned by an account
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          GET accounts/:account_identifier/storage/kv/namespaces
                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                          page
                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                          Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          1
                                                                                                                                                                                                                                                                                                                                                          • default value: 1
                                                                                                                                                                                                                                                                                                                                                          • min value:1
                                                                                                                                                                                                                                                                                                                                                          per_page
                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                          Maximum number of results per page
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          20
                                                                                                                                                                                                                                                                                                                                                          • default value: 20
                                                                                                                                                                                                                                                                                                                                                          • min value:5
                                                                                                                                                                                                                                                                                                                                                          • max value:100
                                                                                                                                                                                                                                                                                                                                                          order
                                                                                                                                                                                                                                                                                                                                                          Field to order results by
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          "id"
                                                                                                                                                                                                                                                                                                                                                          • valid values: id, title
                                                                                                                                                                                                                                                                                                                                                          direction
                                                                                                                                                                                                                                                                                                                                                          Direction to order namespaces
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          "asc"
                                                                                                                                                                                                                                                                                                                                                          • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces?page=1&per_page=20&order=id&direction=asc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "0f2ac74b498b48028cb68387c421e279",
      "title": "My Own Namespace",
      "supports_url_encoding": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                          workers-kv-namespace-create-a-namespace
                                                                                                                                                                                                                                                                                                                                                          POST Create a Namespace permission needed: com.cloudflare.edge.storage.kv.namespace.create
                                                                                                                                                                                                                                                                                                                                                          Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          POST accounts/:account_identifier/storage/kv/namespaces
                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                          title
                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                          A human-readable string name for a Namespace.
                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                          "My Own Namespace"
                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"title":"My Own Namespace"}'
                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "0f2ac74b498b48028cb68387c421e279",
    "title": "My Own Namespace",
    "supports_url_encoding": true
  }
}
                                                                                                                                                                                                                                                                                                                                                            workers-kv-namespace-remove-a-namespace
                                                                                                                                                                                                                                                                                                                                                            DELETE Remove a Namespace permission needed: com.cloudflare.edge.storage.kv.namespace.delete
                                                                                                                                                                                                                                                                                                                                                            Deletes the namespace corresponding to the given ID.
                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier
                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                            workers-kv-namespace-rename-a-namespace
                                                                                                                                                                                                                                                                                                                                                            PUT Rename a Namespace permission needed: com.cloudflare.edge.storage.kv.namespace.delete
                                                                                                                                                                                                                                                                                                                                                            Modifies a namespace's title.
                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                            PUT accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier
                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                            title
                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                            A human-readable string name for a Namespace.
                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                            "My Own Namespace"
                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"title":"My Own Namespace"}'
                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                              workers-kv-namespace-list-a-namespace-s-keys
                                                                                                                                                                                                                                                                                                                                                              GET List a Namespace's Keys permission needed: com.cloudflare.edge.storage.kv.key.list
                                                                                                                                                                                                                                                                                                                                                              Lists a namespace's keys.
                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/keys
                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                              limit
                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                              The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.
                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                              1000
                                                                                                                                                                                                                                                                                                                                                              • default value: 1000
                                                                                                                                                                                                                                                                                                                                                              • min value:10
                                                                                                                                                                                                                                                                                                                                                              • max value:1000
                                                                                                                                                                                                                                                                                                                                                              cursor
                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                              Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.
                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                              "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw"
                                                                                                                                                                                                                                                                                                                                                                prefix
                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned.
                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                "My-Prefix"
                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/keys?limit=1000&cursor=6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw&prefix=My-Prefix" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "name": "My-Key",
      "expiration": 1577836800,
      "metadata": {
        "someMetadataKey": "someMetadataValue"
      }
    }
  ],
  "result_info": {
    "count": 1,
    "cursor": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw"
  }
}
                                                                                                                                                                                                                                                                                                                                                                  workers-kv-namespace-read-key-value-pair
                                                                                                                                                                                                                                                                                                                                                                  GET Read key-value pair permission needed: com.cloudflare.edge.storage.kv.key.read
                                                                                                                                                                                                                                                                                                                                                                  Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the "Expiration" response header.
                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/values/:key_name
                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                  "Some Value"
                                                                                                                                                                                                                                                                                                                                                                  workers-kv-namespace-write-key-value-pair
                                                                                                                                                                                                                                                                                                                                                                  PUT Write key-value pair permission needed: com.cloudflare.edge.storage.kv.key.update
                                                                                                                                                                                                                                                                                                                                                                  Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored. Existing values and expirations will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, expiration_ttl is used and expiration is ignored.
                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/values/:key_name?expiration=:expiration&expiration_ttl=:expiration_ttl
                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key?expiration=1578435000&expiration_ttl=300" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: text/plain" \
     --data '"Some Value"'
                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                  workers-kv-namespace-write-key-value-pair-with-metadata
                                                                                                                                                                                                                                                                                                                                                                  PUT Write key-value pair with metadata permission needed: com.cloudflare.edge.storage.kv.key.update
                                                                                                                                                                                                                                                                                                                                                                  Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored along with json metadata to be associated with the key/value pair. Existing values, expirations and metadata will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, expiration_ttl is used and expiration is ignored.
                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/values/:key_name?expiration=:expiration&expiration_ttl=:expiration_ttl
                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                  value
                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                  A byte sequence to be stored, up to 10 MB in length.
                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                  "Some Value"
                                                                                                                                                                                                                                                                                                                                                                    metadata
                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                    Arbitrary JSON to be associated with a key/value pair
                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                    "{\"someMetadataKey\": \"someMetadataValue\"}"
                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key?expiration=1578435000&expiration_ttl=300" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: multipart/form-data" \
     --form 'value=Some Value' \
     --form 'metadata={"someMetadataKey": "someMetadataValue"}'
                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                      workers-kv-namespace-write-multiple-key-value-pairs
                                                                                                                                                                                                                                                                                                                                                                      PUT Write multiple key-value pairs permission needed: com.cloudflare.edge.storage.kv.key.update
                                                                                                                                                                                                                                                                                                                                                                      Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, expiration_ttl is used and expiration is ignored. The entire request size must be 100 megabytes or less.
                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                      PUT accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/bulk
                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                      key
                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                      A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.
                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                      "My-Key"
                                                                                                                                                                                                                                                                                                                                                                      • max length: 512
                                                                                                                                                                                                                                                                                                                                                                      value
                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                      A UTF-8 encoded string to be stored, up to 10 MB in length.
                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                      "Some string"
                                                                                                                                                                                                                                                                                                                                                                      • max length: 10485760
                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                      expiration
                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                      The time, measured in number of seconds since the UNIX epoch, at which the key should expire.
                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                      1578435000
                                                                                                                                                                                                                                                                                                                                                                        expiration_ttl
                                                                                                                                                                                                                                                                                                                                                                        number
                                                                                                                                                                                                                                                                                                                                                                        The number of seconds for which the key should be visible before it expires. At least 60.
                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                        300
                                                                                                                                                                                                                                                                                                                                                                          metadata
                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                          Arbitrary JSON that is associated with a key
                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                          {
  "someMetadataKey": "someMetadataValue"
}
                                                                                                                                                                                                                                                                                                                                                                            base64
                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                            Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/bulk" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"key":"My-Key","value":"Some string","expiration":1578435000,"expiration_ttl":300,"metadata":{"someMetadataKey":"someMetadataValue"},"base64":false}]'
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                            workers-kv-namespace-delete-key-value-pair
                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete key-value pair permission needed: com.cloudflare.edge.storage.kv.key.delete
                                                                                                                                                                                                                                                                                                                                                                            Remove a KV pair from the Namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/values/:key_name
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/values/My-Key" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                            workers-kv-namespace-delete-multiple-key-value-pairs
                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete multiple key-value pairs permission needed: com.cloudflare.edge.storage.kv.key.delete
                                                                                                                                                                                                                                                                                                                                                                            Remove multiple KV pairs from the Namespace. Body should be an array of up to 10,000 keys to be removed.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_identifier/storage/kv/namespaces/:namespace_identifier/bulk
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/kv/namespaces/0f2ac74b498b48028cb68387c421e279/bulk" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '["My-Key"]'
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                            Workers KV Namespace error codes
                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                            10001service temporarily unavailable
                                                                                                                                                                                                                                                                                                                                                                            10002missing CF-Ray header
                                                                                                                                                                                                                                                                                                                                                                            10003missing account public ID
                                                                                                                                                                                                                                                                                                                                                                            10004missing account tag
                                                                                                                                                                                                                                                                                                                                                                            10005URL parameter account tag does not match JWT account tag
                                                                                                                                                                                                                                                                                                                                                                            10006malformed account tag
                                                                                                                                                                                                                                                                                                                                                                            10007malformed page argument
                                                                                                                                                                                                                                                                                                                                                                            10008malformed per_page argument
                                                                                                                                                                                                                                                                                                                                                                            10009key not found
                                                                                                                                                                                                                                                                                                                                                                            10010malformed namespace
                                                                                                                                                                                                                                                                                                                                                                            10011malformed namespace ID
                                                                                                                                                                                                                                                                                                                                                                            10012malformed value
                                                                                                                                                                                                                                                                                                                                                                            10013namespace not found
                                                                                                                                                                                                                                                                                                                                                                            10014namespace already exists
                                                                                                                                                                                                                                                                                                                                                                            10015missing account internal ID
                                                                                                                                                                                                                                                                                                                                                                            10016malformed account internal ID
                                                                                                                                                                                                                                                                                                                                                                            10018too many namespaces in this account
                                                                                                                                                                                                                                                                                                                                                                            10019missing title
                                                                                                                                                                                                                                                                                                                                                                            10021this namespace does not support the list-keys endpoint
                                                                                                                                                                                                                                                                                                                                                                            10022too many requests
                                                                                                                                                                                                                                                                                                                                                                            10024payload too large
                                                                                                                                                                                                                                                                                                                                                                            10025endpoint does not exist
                                                                                                                                                                                                                                                                                                                                                                            10026not entitled
                                                                                                                                                                                                                                                                                                                                                                            10028invalid limit argument
                                                                                                                                                                                                                                                                                                                                                                            10029invalid request
                                                                                                                                                                                                                                                                                                                                                                            10030key too long
                                                                                                                                                                                                                                                                                                                                                                            10033invalid expiration
                                                                                                                                                                                                                                                                                                                                                                            10034invalid expiration ttl
                                                                                                                                                                                                                                                                                                                                                                            10035this namespace does not support the bulk endpoint
                                                                                                                                                                                                                                                                                                                                                                            10037the user lacks the permissions to perform this operation
                                                                                                                                                                                                                                                                                                                                                                            10038this namespace does not support the list-keys prefix parameter
                                                                                                                                                                                                                                                                                                                                                                            10041invalid "list keys" cursor
                                                                                                                                                                                                                                                                                                                                                                            10042illegal key name
                                                                                                                                                                                                                                                                                                                                                                            10043invalid order
                                                                                                                                                                                                                                                                                                                                                                            10044invalid direction
                                                                                                                                                                                                                                                                                                                                                                            10045deprecated endpoint
                                                                                                                                                                                                                                                                                                                                                                            10046too many bulk requests
                                                                                                                                                                                                                                                                                                                                                                            10047invalid metadata
                                                                                                                                                                                                                                                                                                                                                                            10048free limit reached
                                                                                                                                                                                                                                                                                                                                                                            Workers KV Request Analytics
                                                                                                                                                                                                                                                                                                                                                                            Metrics on Workers KV requests.
                                                                                                                                                                                                                                                                                                                                                                            workers-kv-request-analytics
                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                            workers-kv-request-analytics-query-request-analytics
                                                                                                                                                                                                                                                                                                                                                                            GET Query Request Analytics 
                                                                                                                                                                                                                                                                                                                                                                            Retrieves Workers KV request metrics for the given account.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/storage/analytics
                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                            limit
                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                            Limit number of returned metrics.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            10000
                                                                                                                                                                                                                                                                                                                                                                            • default value: 10000
                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                            Start of time interval to query, defaults to 6 hours before request received.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            "2019-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                            • default value: <6 hours ago>
                                                                                                                                                                                                                                                                                                                                                                            until
                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                            End of time interval to query, defaults to current time.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            "2019-01-02T03:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                            • default value: <now>
                                                                                                                                                                                                                                                                                                                                                                            metrics
                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                            One or more metrics to compute.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            [
  "requests",
  "readKiB"
]
                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                            • default value: ["requests"]
                                                                                                                                                                                                                                                                                                                                                                            dimensions
                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                            Can be used to break down the data by given attributes.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            [
  "accountId",
  "responseCode"
]
                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                            • default value: []
                                                                                                                                                                                                                                                                                                                                                                            sort
                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                            Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending)
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            [
  "+requests",
  "-responseCode"
]
                                                                                                                                                                                                                                                                                                                                                                            • default value: []
                                                                                                                                                                                                                                                                                                                                                                            filters
                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                            Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are: 
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                            
Operator
Name
URL Encoded

                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                            
==
Equals
%3D%3D

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
!=
Does not equals
!%3D

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
>
Greater Than
%3E

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
<
Less Than
%3C

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
>=
Greater than or equal to
%3E%3D

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
<=
Less than or equal to
%3C%3D     

                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            "requestType==read AND responseCode!=200"
                                                                                                                                                                                                                                                                                                                                                                            • default value: ""
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/analytics?limit=10000&since=2019-01-02T02:20:00Z&until=2019-01-02T03:20:00Z&metrics=requests,readKiB&dimensions=accountId,responseCode&sort=+requests,-responseCode&filters=requestType==read AND responseCode!=200" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "rows": 2,
    "data": [
      {
        "metrics": [
          [
            2,
            4
          ],
          [
            16,
            32
          ]
        ]
      }
    ],
    "data_lag": 0,
    "min": {
      "requests": 2,
      "readKiB": 16
    },
    "max": {
      "requests": 4,
      "readKiB": 32
    },
    "totals": {
      "requests": 6,
      "readKiB": 48
    },
    "query": {
      "limit": 10000,
      "since": "2019-01-02T02:20:00Z",
      "until": "2019-01-02T03:20:00Z",
      "metrics": [
        "requests",
        "readKiB"
      ],
      "dimensions": [
        "accountId",
        "responseCode"
      ],
      "sort": [
        "+requests",
        "-responseCode"
      ],
      "filters": "requestType==read AND responseCode!=200"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                            Workers KV Request Analytics error codes
                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                            10001missing CF-Ray header
                                                                                                                                                                                                                                                                                                                                                                            10002missing account ID
                                                                                                                                                                                                                                                                                                                                                                            10003malformed account ID
                                                                                                                                                                                                                                                                                                                                                                            10004malformed query
                                                                                                                                                                                                                                                                                                                                                                            10005unauthorized method
                                                                                                                                                                                                                                                                                                                                                                            10006time range too large
                                                                                                                                                                                                                                                                                                                                                                            10007bad namespace ID
                                                                                                                                                                                                                                                                                                                                                                            10008missing account tag
                                                                                                                                                                                                                                                                                                                                                                            Workers KV Stored Data Analytics
                                                                                                                                                                                                                                                                                                                                                                            Metrics on Workers KV stored data.
                                                                                                                                                                                                                                                                                                                                                                            workers-kv-stored-data-analytics
                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                            workers-kv-stored-data-analytics-query-stored-data-analytics
                                                                                                                                                                                                                                                                                                                                                                            GET Query Stored Data Analytics 
                                                                                                                                                                                                                                                                                                                                                                            Retrieves Workers KV stored data metrics for the given account.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/storage/analytics/stored
                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                            limit
                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                            Limit number of returned metrics.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            10000
                                                                                                                                                                                                                                                                                                                                                                            • default value: 10000
                                                                                                                                                                                                                                                                                                                                                                            since
                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                            Start of time interval to query, defaults to 6 hours before request received.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            "2019-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                            • default value: <6 hours ago>
                                                                                                                                                                                                                                                                                                                                                                            until
                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                            End of time interval to query, defaults to current time.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            "2019-01-02T03:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                            • default value: <now>
                                                                                                                                                                                                                                                                                                                                                                            metrics
                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                            One or more metrics to compute.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            [
  "storedBytes",
  "storedKeys"
]
                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                            • default value: ["storedBytes"]
                                                                                                                                                                                                                                                                                                                                                                            dimensions
                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                            Can be used to break down the data by given attributes.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            [
  "namespaceId"
]
                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                            • default value: []
                                                                                                                                                                                                                                                                                                                                                                            sort
                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                            Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending)
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            [
  "+storedBytes",
  "-namespaceId"
]
                                                                                                                                                                                                                                                                                                                                                                            • default value: []
                                                                                                                                                                                                                                                                                                                                                                            filters
                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                            Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are: 
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                            
Operator
Name
URL Encoded

                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                            
==
Equals
%3D%3D

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
!=
Does not equals
!%3D

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
>
Greater Than
%3E

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
<
Less Than
%3C

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
>=
Greater than or equal to
%3E%3D

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            
<=
Less than or equal to
%3C%3D     

                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            "namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64"
                                                                                                                                                                                                                                                                                                                                                                            • default value: ""
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/storage/analytics/stored?limit=10000&since=2019-01-02T02:20:00Z&until=2019-01-02T03:20:00Z&metrics=storedBytes,storedKeys&dimensions=namespaceId&sort=+storedBytes,-namespaceId&filters=namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "rows": 2,
    "data": [
      {
        "metrics": [
          [
            2,
            4
          ],
          [
            16,
            32
          ]
        ]
      }
    ],
    "data_lag": 0,
    "min": {
      "storedKeys": 2,
      "storedBytes": 16
    },
    "max": {
      "storedKeys": 4,
      "storedBytes": 32
    },
    "totals": {
      "storedKeys": 6,
      "storedBytes": 48
    },
    "query": {
      "limit": 10000,
      "since": "2019-01-02T02:20:00Z",
      "until": "2019-01-02T03:20:00Z",
      "metrics": [
        "storedBytes",
        "storedKeys"
      ],
      "dimensions": [
        "namespaceId"
      ],
      "sort": [
        "+storedBytes",
        "-namespaceId"
      ],
      "filters": "namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                            Workers KV Stored Data Analytics error codes
                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                            10001missing CF-Ray header
                                                                                                                                                                                                                                                                                                                                                                            10002missing account ID
                                                                                                                                                                                                                                                                                                                                                                            10003malformed account ID
                                                                                                                                                                                                                                                                                                                                                                            10004malformed query
                                                                                                                                                                                                                                                                                                                                                                            10005unauthorized method
                                                                                                                                                                                                                                                                                                                                                                            Worker Script (Deprecated)
                                                                                                                                                                                                                                                                                                                                                                            A Worker script is a single script that is executed on matching filters in the Cloudflare edge
                                                                                                                                                                                                                                                                                                                                                                            NOTE: This API is deprecated, please use equivalent /accounts API endpoints where possible. These APIs are for use with the previously limited single-script zones.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            worker-script-deprecated-
                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                            worker-script-deprecated--download-worker
                                                                                                                                                                                                                                                                                                                                                                            GET Download Worker 
                                                                                                                                                                                                                                                                                                                                                                            Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/workers/script
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/workers/script" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Accept: application/javascript"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
                                                                                                                                                                                                                                                                                                                                                                            worker-script-deprecated--delete-worker
                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Worker 
                                                                                                                                                                                                                                                                                                                                                                            Delete your worker. This call has no response body on a successful delete.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:zone_identifier/workers/script
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/workers/script" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            worker-script-deprecated--upload-worker
                                                                                                                                                                                                                                                                                                                                                                            PUT Upload Worker 
                                                                                                                                                                                                                                                                                                                                                                            Upload a worker, or a new version of a worker.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            PUT zones/:zone_identifier/workers/script
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/workers/script" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/javascript" \
--data "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "script": "addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })",
    "etag": "ea95132c15732412d22c1476fa83f27a",
    "size": 1024,
    "modified_on": "2017-01-01T00:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                            Worker Script (Deprecated) error codes
                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                            10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                                            10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                                            10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                                            10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                                            10006Unparseable script body
                                                                                                                                                                                                                                                                                                                                                                            10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                                            10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                                            10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                                            10018Attempted to update a script where the e-tag does not match
                                                                                                                                                                                                                                                                                                                                                                            10021Script content failed validation checks, but was otherwise parseable
                                                                                                                                                                                                                                                                                                                                                                            10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                                            10027Script body was too large
                                                                                                                                                                                                                                                                                                                                                                            Worker Binding (Deprecated)
                                                                                                                                                                                                                                                                                                                                                                            A worker binding is a resource made available to a worker via a JavaScript variable name.
                                                                                                                                                                                                                                                                                                                                                                            NOTE: This API is deprecated, please use equivalent /accounts API endpoints where possible. These APIs are for use with the previously limited single-script zones.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            worker-binding-deprecated-
                                                                                                                                                                                                                                                                                                                                                                            Object definitions
                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                            Show definitions
                                                                                                                                                                                                                                                                                                                                                                            worker-binding-deprecated--list-bindings
                                                                                                                                                                                                                                                                                                                                                                            GET List Bindings 
                                                                                                                                                                                                                                                                                                                                                                            List the bindings for a Workers script.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/workers/script/bindings
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/script/bindings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "name": "myBinding",
      "type": "kv_namespace",
      "namespace_id": "0f2ac74b498b48028cb68387c421e279"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                            Worker Filters (Deprecated)
                                                                                                                                                                                                                                                                                                                                                                            Filters are basic patterns used to enable or disable workers that match requests.
                                                                                                                                                                                                                                                                                                                                                                            NOTE: This API is deprecated, please use equivalent /routes API endpoints where possible. These APIs are for use with the previously limited single-script zones.
                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                            worker-filters-deprecated-
                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                            worker-filters-deprecated--list-filters
                                                                                                                                                                                                                                                                                                                                                                            GET List Filters 
                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_id/workers/filters
                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "9a7806061c88ada191ed06f989cc3dac",
      "pattern": "example.net/*",
      "enabled": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                            worker-filters-deprecated--update-filter
                                                                                                                                                                                                                                                                                                                                                                            PUT Update Filter 
                                                                                                                                                                                                                                                                                                                                                                            PUT zones/:zone_id/workers/filters/:filter_id
                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                            pattern
                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                            "example.net/*"
                                                                                                                                                                                                                                                                                                                                                                              enabled
                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"pattern":"example.net/*","enabled":true}'
                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "pattern": "example.net/*",
    "enabled": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                              worker-filters-deprecated--delete-filter
                                                                                                                                                                                                                                                                                                                                                                              DELETE Delete Filter 
                                                                                                                                                                                                                                                                                                                                                                              DELETE zones/:zone_id/workers/filters/:filter_id
                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                              curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                                              worker-filters-deprecated--create-filter
                                                                                                                                                                                                                                                                                                                                                                              POST Create Filter 
                                                                                                                                                                                                                                                                                                                                                                              POST zones/:zone_id/workers/filters
                                                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                              pattern
                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                              "example.net/*"
                                                                                                                                                                                                                                                                                                                                                                                enabled
                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/workers/filters" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"pattern":"example.net/*","enabled":true}'
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                Worker Filters (Deprecated) error codes
                                                                                                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                                                10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                                                10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                                                10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                                                10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                                                10020Attempted to create a filter for a pattern that already exists
                                                                                                                                                                                                                                                                                                                                                                                10022Filter pattern was invalid
                                                                                                                                                                                                                                                                                                                                                                                10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                                                10026Filter pattern was unparseable
                                                                                                                                                                                                                                                                                                                                                                                Worker Cron Trigger
                                                                                                                                                                                                                                                                                                                                                                                A Worker Cron Trigger schedules a Worker Script to be ran at a specific interval.
                                                                                                                                                                                                                                                                                                                                                                                For more detailed documentation on using the API for Workers see the Workers API.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                worker-cron-trigger
                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                worker-cron-trigger-update-cron-triggers
                                                                                                                                                                                                                                                                                                                                                                                PUT Update Cron Triggers permission needed: com.cloudflare.edge.worker.cron.trigger.update
                                                                                                                                                                                                                                                                                                                                                                                Updates Cron Triggers for a Worker.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/workers/scripts/:script_name/schedules
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/schedules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '"[{'cron': '*/30 * * * *'}]"'
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "schedules": [
      {
        "cron": "*/30 * * * *",
        "created_on": "2017-01-01T00:00:00Z",
        "modified_on": "2017-01-01T00:00:00Z"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                worker-cron-trigger-get-cron-triggers
                                                                                                                                                                                                                                                                                                                                                                                GET Get Cron Triggers permission needed: com.cloudflare.edge.worker.cron.trigger.read
                                                                                                                                                                                                                                                                                                                                                                                Fetches Cron Triggers for a Worker.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/workers/scripts/:script_name/schedules
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/schedules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "schedules": [
      {
        "cron": "*/30 * * * *",
        "created_on": "2017-01-01T00:00:00Z",
        "modified_on": "2017-01-01T00:00:00Z"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                Worker Cron Trigger error codes
                                                                                                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                                                10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                                                10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10005Missing script name
                                                                                                                                                                                                                                                                                                                                                                                10006Unparseable script body
                                                                                                                                                                                                                                                                                                                                                                                10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                                                10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                                                10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                                                10018Attempted to update a script where the e-tag does not match
                                                                                                                                                                                                                                                                                                                                                                                10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                                                10026Unable to parse request body
                                                                                                                                                                                                                                                                                                                                                                                10063workers.dev subdomain required
                                                                                                                                                                                                                                                                                                                                                                                10100Unable to parse cron string
                                                                                                                                                                                                                                                                                                                                                                                Worker Tail Logs
                                                                                                                                                                                                                                                                                                                                                                                Receive websocket URL of trace worker.
                                                                                                                                                                                                                                                                                                                                                                                For more detailed documentation on using the API for Workers see the Workers API.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                worker-tail-logs
                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                worker-tail-logs-start-tail
                                                                                                                                                                                                                                                                                                                                                                                POST Start Tail permission needed: com.cloudflare.edge.worker.script.readcom.cloudflare.edge.worker.tail.create
                                                                                                                                                                                                                                                                                                                                                                                Starts a tail that receives logs and exception from a Worker
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/workers/scripts/:script_name/tails
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/tails" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "03dc9f77817b488fb26c5861ec18f791",
    "url": "wss://tail.developers.workers.dev/03dc9f77817b488fb26c5861ec18f791",
    "expires_at": "2021-08-20T19:15:51Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                worker-tail-logs-list-tails
                                                                                                                                                                                                                                                                                                                                                                                GET List Tails permission needed: com.cloudflare.edge.worker.script.read
                                                                                                                                                                                                                                                                                                                                                                                Get list of tails currently deployed on a worker
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/workers/scripts/:script_name/tails
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/tails" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "03dc9f77817b488fb26c5861ec18f791",
    "url": "wss://tail.developers.workers.dev/03dc9f77817b488fb26c5861ec18f791",
    "expires_at": "2021-08-20T19:15:51Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                worker-tail-logs-delete-tail
                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Tail permission needed: com.cloudflare.edge.worker.script.readcom.cloudflare.edge.worker.tail.create
                                                                                                                                                                                                                                                                                                                                                                                Deletes a tail from a Worker
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                DELETE accounts/:account_identifier/workers/scripts/:script_name/tails/:id
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/scripts/this-is_my_script-01/tails/03dc9f77817b488fb26c5861ec18f791" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                Worker Tail Logs error codes
                                                                                                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                10057Worker has too much traffic to add a tail
                                                                                                                                                                                                                                                                                                                                                                                10059Worker has too many active tails (maximum is 10)
                                                                                                                                                                                                                                                                                                                                                                                10076Worker cannot be tailed due to abuse
                                                                                                                                                                                                                                                                                                                                                                                Worker Subdomain
                                                                                                                                                                                                                                                                                                                                                                                A Worker Subdomain is a unique subdomain specified for each Cloudflare account that enables running Workers without a zone.
                                                                                                                                                                                                                                                                                                                                                                                For more detailed documentation on using the API for Workers see the Workers API.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                worker-subdomain
                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                worker-subdomain-create-subdomain
                                                                                                                                                                                                                                                                                                                                                                                PUT Create Subdomain permission needed: com.cloudflare.edge.worker.cron.subdomain.create
                                                                                                                                                                                                                                                                                                                                                                                Creates a Workers subdomain for an account.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/workers/subdomain
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/subdomain" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '"{'subdomain': 'example-subdomain'}"'
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "example-subdomain"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                worker-subdomain-get-subdomain
                                                                                                                                                                                                                                                                                                                                                                                GET Get Subdomain permission needed: com.cloudflare.edge.worker.cron.subdomain.read
                                                                                                                                                                                                                                                                                                                                                                                Returns a Workers subdomain for an account.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/workers/subdomain
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/subdomain" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "example-subdomain"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                Worker Subdomain error codes
                                                                                                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                                                10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                                                10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                                                10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                                                10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                                                10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                                                10026Unable to parse request body
                                                                                                                                                                                                                                                                                                                                                                                10031Subdomain is unavailable
                                                                                                                                                                                                                                                                                                                                                                                10033Subdomain is invalid
                                                                                                                                                                                                                                                                                                                                                                                10034Email verification is required
                                                                                                                                                                                                                                                                                                                                                                                10035Conflict occurred updating resource
                                                                                                                                                                                                                                                                                                                                                                                10036Subdomain exists for account
                                                                                                                                                                                                                                                                                                                                                                                Worker Account Settings
                                                                                                                                                                                                                                                                                                                                                                                Worker Account Settings specify account-level configurations for a Workers account.
                                                                                                                                                                                                                                                                                                                                                                                For more detailed documentation on using the API for Workers see the Workers API.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                worker-account-settings
                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                worker-account-settings-create-worker-account-settings
                                                                                                                                                                                                                                                                                                                                                                                PUT Create Worker Account Settings permission needed: com.cloudflare.api.account.update
                                                                                                                                                                                                                                                                                                                                                                                Creates Worker Account Settings for an account.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/workers/account-settings
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/account-settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '"{'default_usage_model': 'unbound'}"'
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "default_usage_model": "unbound"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                worker-account-settings-fetch-worker-account-settings
                                                                                                                                                                                                                                                                                                                                                                                GET Fetch Worker Account Settings permission needed: com.cloudflare.api.account.read
                                                                                                                                                                                                                                                                                                                                                                                Fetches Worker Account Settings for an account.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/workers/account-settings
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/workers/account-settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "default_usage_model": "unbound"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                Worker Account Settings error codes
                                                                                                                                                                                                                                                                                                                                                                                CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                10001Unsupported or unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                                                10002Unexpected internal server error
                                                                                                                                                                                                                                                                                                                                                                                10003Missing required URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10004Malformed URL parameter
                                                                                                                                                                                                                                                                                                                                                                                10007Resource not found (similar to HTTP 404)
                                                                                                                                                                                                                                                                                                                                                                                10014Internal error while attempting authorization checks
                                                                                                                                                                                                                                                                                                                                                                                10015The current account is not authorized to use workers
                                                                                                                                                                                                                                                                                                                                                                                10023Unauthorized access attempt
                                                                                                                                                                                                                                                                                                                                                                                10026Unable to parse request body
                                                                                                                                                                                                                                                                                                                                                                                10075Requires a Workers Paid plan
                                                                                                                                                                                                                                                                                                                                                                                10080The current account is not authorized to use green compute
                                                                                                                                                                                                                                                                                                                                                                                Spectrum Applications
                                                                                                                                                                                                                                                                                                                                                                                You can extend the power of Cloudflare's DDoS, TLS, and IP Firewall to your other TCP-based services.
                                                                                                                                                                                                                                                                                                                                                                                spectrum-applications
                                                                                                                                                                                                                                                                                                                                                                                Object definitions
                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                Show definitions
                                                                                                                                                                                                                                                                                                                                                                                Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                End of life Date: August 1, 2020
                                                                                                                                                                                                                                                                                                                                                                                The List Spectrum Applications endpoint will no longer return all applications by default.  Instead, the response will always be paginated in the standard format.  If you are already using the page query parameter, there will be no effective change.  The endpoint itself is NOT being deprecated.
                                                                                                                                                                                                                                                                                                                                                                                spectrum-applications-list-spectrum-applications
                                                                                                                                                                                                                                                                                                                                                                                GET List Spectrum Applications 
                                                                                                                                                                                                                                                                                                                                                                                Retrieve a list of currently existing Spectrum Applications inside a zone.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                GET zones/:zone/spectrum/apps
                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                page
                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, result_info will be present in the response.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                                                                                                                • min value:1
                                                                                                                                                                                                                                                                                                                                                                                per_page
                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                Maximum number of results per page
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                20
                                                                                                                                                                                                                                                                                                                                                                                • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                • min value:1
                                                                                                                                                                                                                                                                                                                                                                                • max value:100
                                                                                                                                                                                                                                                                                                                                                                                direction
                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                Direction to order results
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                "desc"
                                                                                                                                                                                                                                                                                                                                                                                • default value: asc
                                                                                                                                                                                                                                                                                                                                                                                • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                order
                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                Application field to order results by
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                "protocol"
                                                                                                                                                                                                                                                                                                                                                                                • default value: dns
                                                                                                                                                                                                                                                                                                                                                                                • valid values: protocol, app_id, created_on, modified_on, dns
                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps?page=1&per_page=20&direction=desc&order=protocol" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "ea95132c15732412d22c1476fa83f27a",
      "protocol": "tcp/22",
      "dns": {
        "type": "CNAME",
        "name": "ssh.example.com"
      },
      "origin_direct": [
        "tcp://192.0.2.1:22"
      ],
      "proxy_protocol": "off",
      "ip_firewall": true,
      "tls": "full",
      "edge_ips": {
        "type": "dynamic",
        "connectivity": "all"
      },
      "traffic_type": "direct",
      "argo_smart_routing": true,
      "created_on": "2014-01-02T02:20:00Z",
      "modified_on": "2014-01-02T02:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                spectrum-applications-create-spectrum-application
                                                                                                                                                                                                                                                                                                                                                                                POST Create Spectrum Application 
                                                                                                                                                                                                                                                                                                                                                                                Create a new Spectrum Application from a configuration.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                POST zones/:zone/spectrum/apps
                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                origin_direct
                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                A list of destination addresses to the origin.
                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                [
  "tcp://192.0.2.1:22"
]
                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                  dns
                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                  The name and type of DNS record for the Spectrum application.
                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                  {
  "type": "CNAME",
  "name": "ssh.example.com"
}
                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                    protocol
                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                    Port configuration at Cloudflare’s edge. May specify a single port, e.g. "tcp/1000", or a range of ports, e.g. "tcp/1000-2000".
                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                    "tcp/22"
                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                      proxy_protocol
                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                      Enables Proxy Protocol to the origin. See the developer documentation for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      "off"
                                                                                                                                                                                                                                                                                                                                                                                      • default value: off
                                                                                                                                                                                                                                                                                                                                                                                      • valid values: off, v1, v2, simple
                                                                                                                                                                                                                                                                                                                                                                                      edge_ips
                                                                                                                                                                                                                                                                                                                                                                                      The anycast edge IP configuration for the hostname of this application.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      {
  "type": "dynamic",
  "connectivity": "all"
}
                                                                                                                                                                                                                                                                                                                                                                                      One of the following:
                                                                                                                                                                                                                                                                                                                                                                                      • default value: Map { "type": "dynamic", "connectivity": "all" }
                                                                                                                                                                                                                                                                                                                                                                                      argo_smart_routing
                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                      Enables Argo Smart Routing for this application.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                      • notes: Only available for TCP applications with traffic_type set to "direct".
                                                                                                                                                                                                                                                                                                                                                                                      ip_firewall
                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                      Enables IP Access Rules for this application.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                      • notes: Only available for TCP applications.
                                                                                                                                                                                                                                                                                                                                                                                      tls
                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                      The type of TLS termination associated with the application.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      "full"
                                                                                                                                                                                                                                                                                                                                                                                      • valid values: off, flexible, full, strict
                                                                                                                                                                                                                                                                                                                                                                                      traffic_type
                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                      Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the protocol. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      "direct"
                                                                                                                                                                                                                                                                                                                                                                                      • default value: direct
                                                                                                                                                                                                                                                                                                                                                                                      • valid values: direct, http, https
                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"protocol":"tcp/22","dns":{"type":"CNAME","name":"ssh.example.com"},"origin_direct":["tcp://192.0.2.1:22"],"proxy_protocol":"off","ip_firewall":true,"tls":"full","edge_ips":{"type":"dynamic","connectivity":"all"},"traffic_type":"direct","argo_smart_routing":true}'
                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ea95132c15732412d22c1476fa83f27a",
    "protocol": "tcp/22",
    "dns": {
      "type": "CNAME",
      "name": "ssh.example.com"
    },
    "origin_direct": [
      "tcp://192.0.2.1:22"
    ],
    "proxy_protocol": "off",
    "ip_firewall": true,
    "tls": "full",
    "edge_ips": {
      "type": "dynamic",
      "connectivity": "all"
    },
    "traffic_type": "direct",
    "argo_smart_routing": true,
    "created_on": "2014-01-02T02:20:00Z",
    "modified_on": "2014-01-02T02:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                      spectrum-applications-get-spectrum-application-configuration
                                                                                                                                                                                                                                                                                                                                                                                      GET Get Spectrum Application Configuration 
                                                                                                                                                                                                                                                                                                                                                                                      Get the application configuration of a specific application inside a zone.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone/spectrum/apps/:app_id
                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ea95132c15732412d22c1476fa83f27a",
    "protocol": "tcp/22",
    "dns": {
      "type": "CNAME",
      "name": "ssh.example.com"
    },
    "origin_direct": [
      "tcp://192.0.2.1:22"
    ],
    "proxy_protocol": "off",
    "ip_firewall": true,
    "tls": "full",
    "edge_ips": {
      "type": "dynamic",
      "connectivity": "all"
    },
    "traffic_type": "direct",
    "argo_smart_routing": true,
    "created_on": "2014-01-02T02:20:00Z",
    "modified_on": "2014-01-02T02:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                      spectrum-applications-update-spectrum-application-configuration
                                                                                                                                                                                                                                                                                                                                                                                      PUT Update Spectrum Application Configuration 
                                                                                                                                                                                                                                                                                                                                                                                      Update a previously existing application's configuration.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:zone/spectrum/apps/:app_id
                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                      origin_direct
                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                      A list of destination addresses to the origin.
                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                      [
  "tcp://192.0.2.1:22"
]
                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                        dns
                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                        The name and type of DNS record for the Spectrum application.
                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                        {
  "type": "CNAME",
  "name": "ssh.example.com"
}
                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                          protocol
                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                          Port configuration at Cloudflare’s edge. May specify a single port, e.g. "tcp/1000", or a range of ports, e.g. "tcp/1000-2000".
                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                          "tcp/22"
                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                            proxy_protocol
                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                            Enables Proxy Protocol to the origin. See the developer documentation for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            "off"
                                                                                                                                                                                                                                                                                                                                                                                            • default value: off
                                                                                                                                                                                                                                                                                                                                                                                            • valid values: off, v1, v2, simple
                                                                                                                                                                                                                                                                                                                                                                                            edge_ips
                                                                                                                                                                                                                                                                                                                                                                                            The anycast edge IP configuration for the hostname of this application.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            {
  "type": "dynamic",
  "connectivity": "all"
}
                                                                                                                                                                                                                                                                                                                                                                                            One of the following:
                                                                                                                                                                                                                                                                                                                                                                                            • default value: Map { "type": "dynamic", "connectivity": "all" }
                                                                                                                                                                                                                                                                                                                                                                                            argo_smart_routing
                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                            Enables Argo Smart Routing for this application.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                            • notes: Only available for TCP applications with traffic_type set to "direct".
                                                                                                                                                                                                                                                                                                                                                                                            ip_firewall
                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                            Enables IP Access Rules for this application.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                            • notes: Only available for TCP applications.
                                                                                                                                                                                                                                                                                                                                                                                            tls
                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                            The type of TLS termination associated with the application.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            "full"
                                                                                                                                                                                                                                                                                                                                                                                            • valid values: off, flexible, full, strict
                                                                                                                                                                                                                                                                                                                                                                                            traffic_type
                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                            Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the protocol. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            "direct"
                                                                                                                                                                                                                                                                                                                                                                                            • default value: direct
                                                                                                                                                                                                                                                                                                                                                                                            • valid values: direct, http, https
                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"protocol":"tcp/22","dns":{"type":"CNAME","name":"ssh.example.com"},"origin_direct":["tcp://192.0.2.1:22"],"proxy_protocol":"off","ip_firewall":true,"tls":"full","edge_ips":{"type":"dynamic","connectivity":"all"},"traffic_type":"direct","argo_smart_routing":true}'
                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ea95132c15732412d22c1476fa83f27a",
    "protocol": "tcp/22",
    "dns": {
      "type": "CNAME",
      "name": "ssh.example.com"
    },
    "origin_direct": [
      "tcp://192.0.2.1:22"
    ],
    "proxy_protocol": "off",
    "ip_firewall": true,
    "tls": "full",
    "edge_ips": {
      "type": "dynamic",
      "connectivity": "all"
    },
    "traffic_type": "direct",
    "argo_smart_routing": true,
    "created_on": "2014-01-02T02:20:00Z",
    "modified_on": "2014-01-02T02:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                            spectrum-applications-delete-spectrum-application
                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Spectrum Application 
                                                                                                                                                                                                                                                                                                                                                                                            Delete a previously existing application.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:zone/spectrum/apps/:app_id
                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/apps/ea95132c15732412d22c1476fa83f27a" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ea95132c15732412d22c1476fa83f27a"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                            Spectrum Applications error codes
                                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                            10000Unknown Error
                                                                                                                                                                                                                                                                                                                                                                                            10001Unexpected Content Type
                                                                                                                                                                                                                                                                                                                                                                                            10002Internal Server Error
                                                                                                                                                                                                                                                                                                                                                                                            10003Missing Required URL Param
                                                                                                                                                                                                                                                                                                                                                                                            10004Malformed URL Param
                                                                                                                                                                                                                                                                                                                                                                                            10005JSON Parsing Error
                                                                                                                                                                                                                                                                                                                                                                                            10006Resource Not Found
                                                                                                                                                                                                                                                                                                                                                                                            10007Forbidden
                                                                                                                                                                                                                                                                                                                                                                                            11000Invalid Origin Configuration
                                                                                                                                                                                                                                                                                                                                                                                            11002Invalid Origin Address
                                                                                                                                                                                                                                                                                                                                                                                            11003Invalid Edge Port
                                                                                                                                                                                                                                                                                                                                                                                            11004Invalid DNS Configuration
                                                                                                                                                                                                                                                                                                                                                                                            11005Proxy Protocol v1 Not Supported for non TCP Applications
                                                                                                                                                                                                                                                                                                                                                                                            11006TLS Termination Not Supported for non TCP Applications
                                                                                                                                                                                                                                                                                                                                                                                            11007Origin/Edge Transport Mismatch
                                                                                                                                                                                                                                                                                                                                                                                            11008UDP Not Enabled
                                                                                                                                                                                                                                                                                                                                                                                            12000No Address Available
                                                                                                                                                                                                                                                                                                                                                                                            13000Protocol Not Found
                                                                                                                                                                                                                                                                                                                                                                                            13002Protocol Not Available
                                                                                                                                                                                                                                                                                                                                                                                            14002Port Conflict
                                                                                                                                                                                                                                                                                                                                                                                            1402DNS Validation Error
                                                                                                                                                                                                                                                                                                                                                                                            81053DNS Record Exists Error
                                                                                                                                                                                                                                                                                                                                                                                            Spectrum Analytics (Summary)
                                                                                                                                                                                                                                                                                                                                                                                            Summarized analytics data for Spectrum applications.
                                                                                                                                                                                                                                                                                                                                                                                            spectrum-analytics-summary-
                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                            spectrum-analytics-summary--get-analytics-summary
                                                                                                                                                                                                                                                                                                                                                                                            GET Get Analytics Summary 
                                                                                                                                                                                                                                                                                                                                                                                            Retrieves a list of summarised aggregate metrics over a given time period.
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone/spectrum/analytics/events/summary
                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                            metrics
                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                            One or more metrics to compute. Options are: 
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                                            
Metric
Name
Example
Unit

                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                                            
count
Count of total events
1000
Count

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            
bytesIngress
Sum of ingress bytes
1000
Sum

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            
bytesEgress
Sum of egress bytes
1000
Sum

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            
durationAvg
Average connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            
durationMedian
Median connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            
duration90th
90th percentile connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            
duration99th
99th percentile connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                            [
  "count",
  "bytesIngress"
]
                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                              dimensions
                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                              Can be used to break down the data by given attributes. Options are: 
                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              


                                                                                                                                                                                                                                                                                                                                                                                              
Dimension
Name
Example

                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              


                                                                                                                                                                                                                                                                                                                                                                                              
event
Connection Event
connect, progress, disconnect, originError, clientFiltered

                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              
appID
Application ID
40d67c87c6cd4b889a4fd57805225e85

                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              
coloName
Colo Name
SFO

                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              
ipVersion
IP version used by the client
4, 6

                                                                                                                                                                                                                                                                                                                                                                                              
                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                              [
  "event",
  "appID"
]
                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                filters
                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are: 
                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                


                                                                                                                                                                                                                                                                                                                                                                                                
Operator
Name
URL Encoded

                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                


                                                                                                                                                                                                                                                                                                                                                                                                
==
Equals
%3D%3D

                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                
!=
Does not equals
!%3D

                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                
>
Greater Than
%3E

                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                
<
Less Than
%3C

                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                
>=
Greater than or equal to
%3E%3D

                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                
<=
Less than or equal to
%3C%3D     

                                                                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                "event==disconnect%20AND%20coloName!=SFO"
                                                                                                                                                                                                                                                                                                                                                                                                  sort
                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                  The sort order for the result set; sort fields must be included in metrics or dimensions.
                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                  [
  "+count",
  "-bytesIngress"
]
                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                    string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                    Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                    "2014-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                      until
                                                                                                                                                                                                                                                                                                                                                                                                      string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                      End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                      "2014-01-02T03:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/analytics/events/summary?metrics=count,bytesIngress&dimensions=event,appID&filters=event==disconnect%20AND%20coloName!=SFO&sort=+count,-bytesIngress&since=2014-01-02T02:20:00Z&until=2014-01-02T03:20:00Z" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                        Spectrum Analytics (By Time)
                                                                                                                                                                                                                                                                                                                                                                                                        Analytics data for Spectrum applications grouped by time interval.
                                                                                                                                                                                                                                                                                                                                                                                                        spectrum-analytics-by-time-
                                                                                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                                                                                        spectrum-analytics-by-time--get-analytics-by-time
                                                                                                                                                                                                                                                                                                                                                                                                        GET Get Analytics By Time 
                                                                                                                                                                                                                                                                                                                                                                                                        Retrieves a list of aggregate metrics grouped by time interval.
                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone/spectrum/analytics/events/bytime
                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                        metrics
                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                        One or more metrics to compute. Options are: 
                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        


                                                                                                                                                                                                                                                                                                                                                                                                        
Metric
Name
Example
Unit

                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                        


                                                                                                                                                                                                                                                                                                                                                                                                        
count
Count of total events
1000
Count

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        
bytesIngress
Sum of ingress bytes
1000
Sum

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        
bytesEgress
Sum of egress bytes
1000
Sum

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        
durationAvg
Average connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        
durationMedian
Median connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        
duration90th
90th percentile connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        
duration99th
99th percentile connection duration
1.0
Time in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                        [
  "count",
  "bytesIngress"
]
                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                          dimensions
                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                          Can be used to break down the data by given attributes. Options are: 
                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                          


                                                                                                                                                                                                                                                                                                                                                                                                          
Dimension
Name
Example

                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                          


                                                                                                                                                                                                                                                                                                                                                                                                          
event
Connection Event
connect, progress, disconnect, originError, clientFiltered

                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                          
appID
Application ID
40d67c87c6cd4b889a4fd57805225e85

                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                          
coloName
Colo Name
SFO

                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                          
ipVersion
IP version used by the client
4, 6

                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                          [
  "event",
  "appID"
]
                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                            filters
                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                            Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Comparison options are: 
                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                                                            
Operator
Name
URL Encoded

                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                            


                                                                                                                                                                                                                                                                                                                                                                                                            
==
Equals
%3D%3D

                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            
!=
Does not equals
!%3D

                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            
>
Greater Than
%3E

                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            
<
Less Than
%3C

                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            
>=
Greater than or equal to
%3E%3D

                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            
<=
Less than or equal to
%3C%3D     

                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                            "event==disconnect%20AND%20coloName!=SFO"
                                                                                                                                                                                                                                                                                                                                                                                                              sort
                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                              The sort order for the result set; sort fields must be included in metrics or dimensions.
                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                              [
  "+count",
  "-bytesIngress"
]
                                                                                                                                                                                                                                                                                                                                                                                                                since
                                                                                                                                                                                                                                                                                                                                                                                                                string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                Start of time interval to query, defaults to until - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                "2014-01-02T02:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                  until
                                                                                                                                                                                                                                                                                                                                                                                                                  string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                  End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                  "2014-01-02T03:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                    time_delta
                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                    Used to select time series resolution.
                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                    "minute"
                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: year, quarter, month, week, day, hour, dekaminute, minute
                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/analytics/events/bytime?metrics=count,bytesIngress&dimensions=event,appID&filters=event==disconnect%20AND%20coloName!=SFO&sort=+count,-bytesIngress&since=2014-01-02T02:20:00Z&until=2014-01-02T03:20:00Z&time_delta=minute" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                    Spectrum Aggregate Analytics
                                                                                                                                                                                                                                                                                                                                                                                                                    Aggregated Analytics for Spectrum in real time.
                                                                                                                                                                                                                                                                                                                                                                                                                    spectrum-aggregate-analytics
                                                                                                                                                                                                                                                                                                                                                                                                                    Object definitions
                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                    Show definitions
                                                                                                                                                                                                                                                                                                                                                                                                                    spectrum-aggregate-analytics-get-current-aggregate-analytics
                                                                                                                                                                                                                                                                                                                                                                                                                    GET Get Current Aggregate Analytics 
                                                                                                                                                                                                                                                                                                                                                                                                                    Retrieves analytics aggregated from the last minute of usage on Spectrum Applications underneath a given zone.
                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                    GET zones/:zone/spectrum/analytics/aggregate/current
                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                    coloName
                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                    Co-location Identifier.
                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                    "PDX"
                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 3
                                                                                                                                                                                                                                                                                                                                                                                                                    appID
                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                    Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.
                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                    "ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f"
                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/spectrum/analytics/aggregate/current?coloName=PDX&appID=ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "appID": "ea95132c15732412d22c1476fa83f27a",
      "bytesIngress": 500,
      "bytesEgress": 500,
      "connections": 10,
      "durationAvg": 10000
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                      Page Rules for a Zone
                                                                                                                                                                                                                                                                                                                                                                                                                      A rule describing target patterns for requests and actions to perform on matching requests
                                                                                                                                                                                                                                                                                                                                                                                                                      page-rules-for-a-zone
                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                      page-rules-for-a-zone-list-page-rules
                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Page Rules permission needed: #zone:read
                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_identifier/pagerules
                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                      status
                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                      Status of the page rule
                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                      "active"
                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: disabled
                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: active, disabled
                                                                                                                                                                                                                                                                                                                                                                                                                      order
                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                      Field to order page rules by
                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                      "status"
                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: priority
                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: status, priority
                                                                                                                                                                                                                                                                                                                                                                                                                      direction
                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                      Direction to order page rules
                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                      "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: desc
                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                      match
                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                      Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                      "all"
                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules?status=active&order=status&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "9a7806061c88ada191ed06f989cc3dac",
      "targets": [
        {
          "target": "url",
          "constraint": {
            "operator": "matches",
            "value": "*example.com/images/*"
          }
        }
      ],
      "actions": [
        {
          "id": "always_online",
          "value": "on"
        }
      ],
      "priority": 1,
      "status": "active",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "created_on": "2014-01-01T05:20:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                      page-rules-for-a-zone-create-page-rule
                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create Page Rule permission needed: #zone:edit
                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                      POST zones/:zone_identifier/pagerules
                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                      targets
                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                      Targets to evaluate on a request
                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "target": "url",
    "constraint": {
      "operator": "matches",
      "value": "*example.com/images/*"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                        actions
                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                        The set of actions to perform if the targets of this rule match the request. Actions can redirect the url to another url or override settings (but not both)
                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "id": "always_online",
    "value": "on"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                          priority
                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                          A number that indicates the preference for a page rule over another. In the case where you may have a catch-all page rule (e.g., #1: '/images/') but want a rule that is more specific to take precedence (e.g., #2: '/images/special/'), you'll want to specify a higher priority on the latter (#2) so it will override the first.
                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                          1
                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                          status
                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                          Status of the page rule
                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                          "active"
                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: disabled
                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: active, disabled
                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"targets":[{"target":"url","constraint":{"operator":"matches","value":"*example.com/images/*"}}],"actions":[{"id":"always_online","value":"on"}],"priority":1,"status":"active"}'
                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "targets": [
      {
        "target": "url",
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        }
      }
    ],
    "actions": [
      {
        "id": "always_online",
        "value": "on"
      }
    ],
    "priority": 1,
    "status": "active",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "created_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                          page-rules-for-a-zone-page-rule-details
                                                                                                                                                                                                                                                                                                                                                                                                                          GET Page Rule Details permission needed: #zone:read
                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:zone_identifier/pagerules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "targets": [
      {
        "target": "url",
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        }
      }
    ],
    "actions": [
      {
        "id": "always_online",
        "value": "on"
      }
    ],
    "priority": 1,
    "status": "active",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "created_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                          page-rules-for-a-zone-update-page-rule
                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update Page Rule permission needed: #zone:edit
                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                          Replace a page rule. The final rule will exactly match the data passed with this request.
                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                          PUT zones/:zone_identifier/pagerules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                          targets
                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                          Targets to evaluate on a request
                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "target": "url",
    "constraint": {
      "operator": "matches",
      "value": "*example.com/images/*"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                            actions
                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                            The set of actions to perform if the targets of this rule match the request. Actions can redirect the url to another url or override settings (but not both)
                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                            [
  {
    "id": "always_online",
    "value": "on"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                              priority
                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                              A number that indicates the preference for a page rule over another. In the case where you may have a catch-all page rule (e.g., #1: '/images/') but want a rule that is more specific to take precedence (e.g., #2: '/images/special/'), you'll want to specify a higher priority on the latter (#2) so it will override the first.
                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                              status
                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                              Status of the page rule
                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                              "active"
                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: disabled
                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: active, disabled
                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"targets":[{"target":"url","constraint":{"operator":"matches","value":"*example.com/images/*"}}],"actions":[{"id":"always_online","value":"on"}],"priority":1,"status":"active"}'
                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "targets": [
      {
        "target": "url",
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        }
      }
    ],
    "actions": [
      {
        "id": "always_online",
        "value": "on"
      }
    ],
    "priority": 1,
    "status": "active",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "created_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                              page-rules-for-a-zone-edit-page-rule
                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH Edit Page Rule permission needed: #zone:edit
                                                                                                                                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                                                                                                                                              • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH zones/:zone_identifier/pagerules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                              targets
                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                              Targets to evaluate on a request
                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "target": "url",
    "constraint": {
      "operator": "matches",
      "value": "*example.com/images/*"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                actions
                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                The set of actions to perform if the targets of this rule match the request. Actions can redirect the url to another url or override settings (but not both)
                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "id": "always_online",
    "value": "on"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                  priority
                                                                                                                                                                                                                                                                                                                                                                                                                                  integer
                                                                                                                                                                                                                                                                                                                                                                                                                                  A number that indicates the preference for a page rule over another. In the case where you may have a catch-all page rule (e.g., #1: '/images/') but want a rule that is more specific to take precedence (e.g., #2: '/images/special/'), you'll want to specify a higher priority on the latter (#2) so it will override the first.
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                  status
                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                  Status of the page rule
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  "active"
                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: active, disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"targets":[{"target":"url","constraint":{"operator":"matches","value":"*example.com/images/*"}}],"actions":[{"id":"always_online","value":"on"}],"priority":1,"status":"active"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "targets": [
      {
        "target": "url",
        "constraint": {
          "operator": "matches",
          "value": "*example.com/images/*"
        }
      }
    ],
    "actions": [
      {
        "id": "always_online",
        "value": "on"
      }
    ],
    "priority": 1,
    "status": "active",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "created_on": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                  page-rules-for-a-zone-delete-page-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete Page Rule permission needed: #zone:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE zones/:zone_identifier/pagerules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                  Available Page Rules for a Zone
                                                                                                                                                                                                                                                                                                                                                                                                                                  A rule describing target patterns for requests and actions to perform on matching requests
                                                                                                                                                                                                                                                                                                                                                                                                                                  available-page-rules-for-a-zone
                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                  available-page-rules-for-a-zone-list-available-page-rule-setting
                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Available Page rule setting permission needed: #zone:read
                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/pagerules/settings
                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/pagerules/settings" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "always_online",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "browser_cache_ttl",
      "properties": [
        {
          "name": "value",
          "type": "range",
          "min": 1800,
          "max": 31536000,
          "suggested_values": [
            1800,
            3600,
            7200,
            10800,
            14400,
            18000,
            28800,
            43200,
            57600,
            72000,
            86400,
            172800,
            259200,
            345600,
            432000,
            691200,
            1382400,
            2073600,
            2678400,
            5356800,
            16070400,
            31536000
          ]
        }
      ]
    },
    {
      "id": "browser_check",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "cache_key_fields",
      "properties": [
        {
          "name": "value",
          "type": "object",
          "properties": [
            {
              "name": "query_string",
              "type": "select",
              "multiple": false,
              "allowEmpty": true,
              "choices": [
                "include",
                "exclude"
              ]
            },
            {
              "name": "header",
              "type": "select",
              "multiple": true,
              "allowEmpty": true,
              "choices": [
                "include",
                "exclude",
                "check_presence"
              ]
            },
            {
              "name": "host",
              "type": "select",
              "multiple": true,
              "allowEmpty": false,
              "choices": [
                "resolved"
              ]
            },
            {
              "name": "cookie",
              "type": "select",
              "multiple": true,
              "allowEmpty": true,
              "choices": [
                "include",
                "check_presence"
              ]
            },
            {
              "name": "user",
              "type": "select",
              "multiple": true,
              "allowEmpty": false,
              "choices": [
                "device_type",
                "geo",
                "lang"
              ]
            }
          ]
        }
      ]
    },
    {
      "id": "cache_deception_armor",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "cache_level",
      "properties": [
        {
          "name": "value",
          "type": "select",
          "multiple": false,
          "choices": [
            "bypass",
            "basic",
            "simplified",
            "aggressive",
            "cache_everything"
          ]
        }
      ]
    },
    {
      "id": "cache_ttl_by_status",
      "properties": [
        {
          "name": "value",
          "type": "object",
          "allowEmpty": false
        }
      ]
    },
    {
      "id": "disable_apps",
      "properties": []
    },
    {
      "id": "disable_performance",
      "properties": []
    },
    {
      "id": "disable_security",
      "properties": []
    },
    {
      "id": "edge_cache_ttl",
      "properties": [
        {
          "name": "value",
          "type": "range",
          "min": 7200,
          "max": 2419200,
          "suggested_values": [
            7200,
            10800,
            14400,
            18000,
            28800,
            43200,
            57600,
            72000,
            86400,
            172800,
            259200,
            345600,
            432000,
            518400,
            604800,
            1209600,
            2419200
          ]
        }
      ]
    },
    {
      "id": "email_obfuscation",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "forwarding_url",
      "properties": [
        {
          "name": "status_code",
          "type": "choice",
          "multiple": false,
          "choices": [
            301,
            302
          ]
        },
        {
          "name": "url",
          "type": "forwardingUrl"
        }
      ]
    },
    {
      "id": "ip_geolocation",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "minify",
      "properties": [
        {
          "name": "value",
          "type": "select",
          "multiple": true,
          "allowEmpty": true,
          "choices": [
            "html",
            "css",
            "js"
          ]
        }
      ]
    },
    {
      "id": "explicit_cache_control",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "rocket_loader",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "security_level",
      "properties": [
        {
          "name": "value",
          "type": "select",
          "multiple": false,
          "choices": [
            "essentially_off",
            "low",
            "medium",
            "high",
            "under_attack"
          ]
        }
      ]
    },
    {
      "id": "server_side_exclude",
      "properties": [
        {
          "name": "value",
          "type": "toggle"
        }
      ]
    },
    {
      "id": "ssl",
      "properties": [
        {
          "name": "value",
          "type": "choice",
          "multiple": false,
          "choices": [
            "off",
            "flexible",
            "full",
            "strict"
          ]
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                  Rate Limits for a Zone
                                                                                                                                                                                                                                                                                                                                                                                                                                  Documentation for Cloudflare Rate Limits
                                                                                                                                                                                                                                                                                                                                                                                                                                  rate-limits-for-a-zone
                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                  rate-limits-for-a-zone-list-rate-limits
                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Rate Limits 
                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                  List the rate limits on a zone.
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/rate_limits
                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                  Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  20
                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits?page=1&per_page=20" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b59",
      "disabled": false,
      "description": "Prevent multiple login failures to mitigate brute force attacks",
      "match": {
        "request": {
          "methods": [
            "GET",
            "POST"
          ],
          "schemes": [
            "HTTP",
            "HTTPS"
          ],
          "url": "*.example.org/path*"
        },
        "response": {},
        "headers": [
          {
            "name": "Cf-Cache-Status",
            "op": "ne",
            "value": "HIT"
          }
        ]
      },
      "bypass": [
        {
          "name": "url",
          "value": "api.example.com/*"
        }
      ],
      "threshold": 60,
      "period": 900,
      "action": {
        "mode": "challenge",
        "timeout": 86400,
        "response": {
          "content_type": "text/xml",
          "body": "<error>This request has been rate-limited.</error>"
        }
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                  rate-limits-for-a-zone-create-rate-limit
                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Rate Limit 
                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                  Create a new rate limit for a zone. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  POST zones/:zone_identifier/rate_limits
                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                  match
                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                  Determines which traffic the rate limit counts towards the threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "request": {
    "methods": [
      "GET",
      "POST"
    ],
    "schemes": [
      "HTTP",
      "HTTPS"
    ],
    "url": "*.example.org/path*"
  },
  "response": {},
  "headers": [
    {
      "name": "Cf-Cache-Status",
      "op": "ne",
      "value": "HIT"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                  One of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                    threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                    The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period
                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                    60
                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                    period
                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                    The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed
                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                    900
                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                    • max value:86400
                                                                                                                                                                                                                                                                                                                                                                                                                                    action
                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                    The action to be performed when the threshold of matched traffic within the period defined is exceeded
                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "mode": "challenge",
  "timeout": 86400,
  "response": {
    "content_type": "text/xml",
    "body": "<error>This request has been rate-limited.</error>"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                    Any of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                      id
                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                      Ratelimit identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                      "372e67954025e0ba6aaa6d586b9e0b59"
                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                      disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether this ratelimit is currently disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                      A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed
                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                      "Prevent multiple login failures to mitigate brute force attacks"
                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                      bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                      Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate limit to a given set of URLs
                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "name": "url",
    "value": "api.example.com/*"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","disabled":false,"description":"Prevent multiple login failures to mitigate brute force attacks","match":{"request":{"methods":["GET","POST"],"schemes":["HTTP","HTTPS"],"url":"*.example.org/path*"},"response":{},"headers":[{"name":"Cf-Cache-Status","op":"ne","value":"HIT"}]},"bypass":[{"name":"url","value":"api.example.com/*"}],"threshold":60,"period":900,"action":{"mode":"challenge","timeout":86400,"response":{"content_type":"text/xml","body":"<error>This request has been rate-limited.</error>"}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "disabled": false,
    "description": "Prevent multiple login failures to mitigate brute force attacks",
    "match": {
      "request": {
        "methods": [
          "GET",
          "POST"
        ],
        "schemes": [
          "HTTP",
          "HTTPS"
        ],
        "url": "*.example.org/path*"
      },
      "response": {},
      "headers": [
        {
          "name": "Cf-Cache-Status",
          "op": "ne",
          "value": "HIT"
        }
      ]
    },
    "bypass": [
      {
        "name": "url",
        "value": "api.example.com/*"
      }
    ],
    "threshold": 60,
    "period": 900,
    "action": {
      "mode": "challenge",
      "timeout": 86400,
      "response": {
        "content_type": "text/xml",
        "body": "<error>This request has been rate-limited.</error>"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                        rate-limits-for-a-zone-rate-limit-details
                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Rate Limit Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/rate_limits/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "disabled": false,
    "description": "Prevent multiple login failures to mitigate brute force attacks",
    "match": {
      "request": {
        "methods": [
          "GET",
          "POST"
        ],
        "schemes": [
          "HTTP",
          "HTTPS"
        ],
        "url": "*.example.org/path*"
      },
      "response": {},
      "headers": [
        {
          "name": "Cf-Cache-Status",
          "op": "ne",
          "value": "HIT"
        }
      ]
    },
    "bypass": [
      {
        "name": "url",
        "value": "api.example.com/*"
      }
    ],
    "threshold": 60,
    "period": 900,
    "action": {
      "mode": "challenge",
      "timeout": 86400,
      "response": {
        "content_type": "text/xml",
        "body": "<error>This request has been rate-limited.</error>"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                        rate-limits-for-a-zone-update-rate-limit
                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Rate Limit 
                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT zones/:zone_identifier/rate_limits/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                        Ratelimit identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                        "372e67954025e0ba6aaa6d586b9e0b59"
                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                        match
                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                        Determines which traffic the rate limit counts towards the threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "request": {
    "methods": [
      "GET",
      "POST"
    ],
    "schemes": [
      "HTTP",
      "HTTPS"
    ],
    "url": "*.example.org/path*"
  },
  "response": {},
  "headers": [
    {
      "name": "Cf-Cache-Status",
      "op": "ne",
      "value": "HIT"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                        One of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                          threshold
                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                          The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period
                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                          60
                                                                                                                                                                                                                                                                                                                                                                                                                                          • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                          period
                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                          The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed
                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                          900
                                                                                                                                                                                                                                                                                                                                                                                                                                          • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                          • max value:86400
                                                                                                                                                                                                                                                                                                                                                                                                                                          action
                                                                                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                                                                                          The action to be performed when the threshold of matched traffic within the period defined is exceeded
                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "mode": "challenge",
  "timeout": 86400,
  "response": {
    "content_type": "text/xml",
    "body": "<error>This request has been rate-limited.</error>"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                          Any of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                            disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether this ratelimit is currently disabled
                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                            A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed
                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                            "Prevent multiple login failures to mitigate brute force attacks"
                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                            bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                                            Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate limit to a given set of URLs
                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  {
    "name": "url",
    "value": "api.example.com/*"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","disabled":false,"description":"Prevent multiple login failures to mitigate brute force attacks","match":{"request":{"methods":["GET","POST"],"schemes":["HTTP","HTTPS"],"url":"*.example.org/path*"},"response":{},"headers":[{"name":"Cf-Cache-Status","op":"ne","value":"HIT"}]},"bypass":[{"name":"url","value":"api.example.com/*"}],"threshold":60,"period":900,"action":{"mode":"challenge","timeout":86400,"response":{"content_type":"text/xml","body":"<error>This request has been rate-limited.</error>"}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "disabled": false,
    "description": "Prevent multiple login failures to mitigate brute force attacks",
    "match": {
      "request": {
        "methods": [
          "GET",
          "POST"
        ],
        "schemes": [
          "HTTP",
          "HTTPS"
        ],
        "url": "*.example.org/path*"
      },
      "response": {},
      "headers": [
        {
          "name": "Cf-Cache-Status",
          "op": "ne",
          "value": "HIT"
        }
      ]
    },
    "bypass": [
      {
        "name": "url",
        "value": "api.example.com/*"
      }
    ],
    "threshold": 60,
    "period": 900,
    "action": {
      "mode": "challenge",
      "timeout": 86400,
      "response": {
        "content_type": "text/xml",
        "body": "<error>This request has been rate-limited.</error>"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                              rate-limits-for-a-zone-delete-rate-limit
                                                                                                                                                                                                                                                                                                                                                                                                                                              DELETE Delete Rate Limit 
                                                                                                                                                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                                                                                                                                                              • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                              DELETE zones/:zone_identifier/rate_limits/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rate_limits/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                              Rate Limits for a Zone error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                              CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                              10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                              10001Rate limit not found
                                                                                                                                                                                                                                                                                                                                                                                                                                              10002Rate limit not unique (edit the existing rather than adding a new)
                                                                                                                                                                                                                                                                                                                                                                                                                                              10004Invalid data submitted
                                                                                                                                                                                                                                                                                                                                                                                                                                              10006Auth missing
                                                                                                                                                                                                                                                                                                                                                                                                                                              10007Auth corrupt
                                                                                                                                                                                                                                                                                                                                                                                                                                              10008Auth expired
                                                                                                                                                                                                                                                                                                                                                                                                                                              10009Unauthorized
                                                                                                                                                                                                                                                                                                                                                                                                                                              10010Time param not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                              10011Pagination results in empty page
                                                                                                                                                                                                                                                                                                                                                                                                                                              10012URL Param incorrect format
                                                                                                                                                                                                                                                                                                                                                                                                                                              10013Patch values not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                              10014Patch operation not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                              10015Patch value not valid for given context
                                                                                                                                                                                                                                                                                                                                                                                                                                              10016Patch not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                              User-level Firewall Access Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                              A firewall access rule applied to all zones owned by the user
                                                                                                                                                                                                                                                                                                                                                                                                                                              user-level-firewall-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                              Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                              View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                              Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                              user-level-firewall-access-rule-list-access-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                              GET List Access Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                                                                                                                                                              • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                              Search, sort, and filter IP/country access rules
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              GET user/firewall/access_rules/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                              notes
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              Search in the access rules by notes.
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "my note"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • notes: Matching any string within previously created access rules with the notes. For example, access rules with notes 'Attack 26/02' & 'Attack 27/02' would both match string 'attack'. Search is not case sensitive.
                                                                                                                                                                                                                                                                                                                                                                                                                                              mode
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                              match
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                                              configuration.target
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              Search rules by target
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "ip"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: ip, ip_range, asn, country
                                                                                                                                                                                                                                                                                                                                                                                                                                              order
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              Field to order rules by
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "mode"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: configuration.target, configuration.value, mode
                                                                                                                                                                                                                                                                                                                                                                                                                                              page
                                                                                                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                                                                                                              Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                              • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                              per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                                                                                                              Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              20
                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                              • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                              • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                              configuration.value
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              Search by IP, range, or country code
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "198.51.100.4"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • notes: IP is a single IPv4 address. IP range has a subnet of /16 or /24. Country code is an ISO 2-letter country code.
                                                                                                                                                                                                                                                                                                                                                                                                                                              direction
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              Direction to order rules
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4&notes=my note&match=all&order=mode&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "92f17202ed8bd63d69a66b86a49a8f6b",
      "notes": "This rule is on because of an event that occured on date X",
      "allowed_modes": [
        "whitelist",
        "block",
        "challenge",
        "js_challenge"
      ],
      "mode": "challenge",
      "configuration": {
        "target": "ip",
        "value": "198.51.100.4"
      },
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "scope": {
        "id": "7c5dae5552338874e5053f2534d2767a",
        "email": "user@example.com",
        "type": "user"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                              user-level-firewall-access-rule-create-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                              POST Create Access Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                                                                                                                                                              • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                              Make a new IP, IP range, or country access rule for all zones owned by the user. Note: If you would like to create an access rule that applies to a specific zone only, use the zone firewall endpoints.
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              POST user/firewall/access_rules/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                              mode
                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                              The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                              configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                              Rule configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "target": "ip",
  "value": "198.51.100.4"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                              One of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                A personal note about the rule. Typically used as a reminder or explanation for the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                "This rule is on because of an event that occured on date X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                  user-level-firewall-access-rule-edit-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Edit Access Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Edit rule state and/or note. This will be applied across all zones owned by the user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH user/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                  mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                  "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                  notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  A personal note about the rule. Typically used as a reminder or explanation for the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                  "This rule is on because of an event that occured on date X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PATCH "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"challenge","notes":"This rule is on because of an event that occured on date X"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                    user-level-firewall-access-rule-delete-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Access Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove an access rule so it is no longer evaluated during requests. This will apply to all zones owned by the user
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE user/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/user/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Account-level Firewall access rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                    A firewall access rule applied to all zones owned by the account
                                                                                                                                                                                                                                                                                                                                                                                                                                                    account-level-firewall-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                    account-level-firewall-access-rule-list-access-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Access Rules permission needed: #waf:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search, sort, and filter IP/country access rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:account_identifier/firewall/access_rules/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                    notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search in the access rules by notes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "my note"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • notes: Matching any string within previously created access rules with the notes. For example, access rules with notes 'Attack 26/02' & 'Attack 27/02' would both match string 'attack'. Search is not case sensitive.
                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                    match
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                                                    configuration.target
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search rules by target
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "ip"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: ip, ip_range, asn, country
                                                                                                                                                                                                                                                                                                                                                                                                                                                    order
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Field to order rules by
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "mode"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: configuration.target, configuration.value, mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                    page
                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                    per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    20
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                    configuration.value
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search by IP, range, or country code
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "198.51.100.4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • notes: IP is a single IPv4 address. IP range has a subnet of /16 or /24. Country code is an ISO 2-letter country code.
                                                                                                                                                                                                                                                                                                                                                                                                                                                    direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Direction to order rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4&notes=my note&match=all&order=mode&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "92f17202ed8bd63d69a66b86a49a8f6b",
      "notes": "This rule is on because of an event that occured on date X",
      "allowed_modes": [
        "whitelist",
        "block",
        "challenge",
        "js_challenge"
      ],
      "mode": "challenge",
      "configuration": {
        "target": "ip",
        "value": "198.51.100.4"
      },
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "scope": {
        "id": "7c5dae5552338874e5053f2534d2767a",
        "email": "user@example.com",
        "type": "user"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                    account-level-firewall-access-rule-create-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create Access Rule permission needed: #waf:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Make a new IP, IP range, or country access rule for all zones owned by the account. Note: If you would like to create an access rule that applies to a specific zone only, use the zone firewall endpoints.
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:account_identifier/firewall/access_rules/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                    The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                    configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Rule configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "target": "ip",
  "value": "198.51.100.4"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                    One of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                      notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                      A personal note about the rule. Typically used as a reminder or explanation for the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                      "This rule is on because of an event that occured on date X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                        account-level-firewall-access-rule-access-rule-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Access Rule Details permission needed: #waf:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the details of an access rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                        account-level-firewall-access-rule-update-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                        PATCH Update Access Rule permission needed: #waf:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update rule state and/or configuration. This will be applied across all zones owned by the account.
                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                        PATCH accounts/:account_identifier/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Access rule identifier tag
                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                        "92f17202ed8bd63d69a66b86a49a8f6b"
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowed_modes
                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                        The possible modes the rule can be in.
                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  "whitelist",
  "block",
  "challenge",
  "js_challenge"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                        mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                        The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                        "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                        configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Rule configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "target": "ip",
  "value": "198.51.100.4"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                        One of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                                          scope
                                                                                                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                                                                                                          All zones owned by the user will have the rule applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "id": "7c5dae5552338874e5053f2534d2767a",
  "email": "user@example.com",
  "type": "user"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                          notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                          A personal note about the rule. Typically used as a reminder or explanation for the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                          "This rule is on because of an event that occured on date X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            created_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            When the rule was created
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "2014-01-01T05:20:00.12345Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                            modified_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            When the rule was last modified
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "2014-01-01T05:20:00.12345Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"92f17202ed8bd63d69a66b86a49a8f6b","notes":"This rule is on because of an event that occured on date X","allowed_modes":["whitelist","block","challenge","js_challenge"],"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"created_on":"2014-01-01T05:20:00.12345Z","modified_on":"2014-01-01T05:20:00.12345Z","scope":{"id":"7c5dae5552338874e5053f2534d2767a","email":"user@example.com","type":"user"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-level-firewall-access-rule-delete-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Access Rule permission needed: #waf:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Remove an access rule so it is no longer evaluated during requests. This will apply to all zones owned by the account
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_identifier/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Firewall Access Rule for a Zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                            An IP, IP range, or country specific firewall rule applied directly to a zone or inherited from user or account-level rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Access Rules are a way to allow, challenge, or block requests to your website based on the IP address, IP address range, or country of the browser making the request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can apply Access Rules to one zone only or all zones in your account. See the User-level or Account-level access rules endpoints for creating rules that are applied across all zones owned by the user or account.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-access-rule-for-a-zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-access-rule-for-a-zone-list-access-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Access Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search, sort, and filter IP/country access rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_id/firewall/access_rules/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                            notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search in the access rules by notes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "my note"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • notes: Matching any string within previously created access rules with the notes. For example, access rules with notes 'Attack 26/02' & 'Attack 27/02' would both match string 'attack'. Search is not case sensitive.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                            match
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                                                            configuration.target
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search rules by target
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "ip"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: ip, ip_range, asn, country
                                                                                                                                                                                                                                                                                                                                                                                                                                                            order
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Field to order rules by
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "mode"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: configuration.target, configuration.value, mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                            page
                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            1
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                            per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            20
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                            configuration.value
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search by IP, range, or country code
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "198.51.100.4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • notes: IP is a single IPv4 address. IP range has a subnet of /16 or /24. Country code is an ISO 2-letter country code.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Direction to order rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules?page=1&per_page=20&mode=challenge&configuration.target=ip&configuration.value=198.51.100.4&notes=my note&match=all&order=mode&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "92f17202ed8bd63d69a66b86a49a8f6b",
      "notes": "This rule is on because of an event that occured on date X",
      "allowed_modes": [
        "whitelist",
        "block",
        "challenge",
        "js_challenge"
      ],
      "mode": "challenge",
      "configuration": {
        "target": "ip",
        "value": "198.51.100.4"
      },
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "scope": {
        "id": "7c5dae5552338874e5053f2534d2767a",
        "email": "user@example.com",
        "type": "user"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-access-rule-for-a-zone-create-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Access Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Make a new IP, IP range, or country access rule for the zone. Note: If you would like to create an access rule that applies across all of your owned zones, use the user or account firewall endpoints as appropriate.
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST zones/:zone_id/firewall/access_rules/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                            The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                            configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                            object
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rule configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "target": "ip",
  "value": "198.51.100.4"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                            One of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                                              notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                              A personal note about the rule. Typically used as a reminder or explanation for the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                              "This rule is on because of an event that occured on date X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"challenge","configuration":{"target":"ip","value":"198.51.100.4"},"notes":"This rule is on because of an event that occured on date X"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                firewall-access-rule-for-a-zone-edit-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH Edit Access Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update rule state and/or note for the zone. Note: you can only edit rules in the 'zone' group via this endpoint. Use the appropriate owner rules endpoint if trying to manage owner-level rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH zones/:zone_id/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                The action to apply to a matched request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: block, challenge, whitelist, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                notes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                A personal note about the rule. Typically used as a reminder or explanation for the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                "This rule is on because of an event that occured on date X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"challenge","notes":"This rule is on because of an event that occured on date X"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b",
    "notes": "This rule is on because of an event that occured on date X",
    "allowed_modes": [
      "whitelist",
      "block",
      "challenge",
      "js_challenge"
    ],
    "mode": "challenge",
    "configuration": {
      "target": "ip",
      "value": "198.51.100.4"
    },
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "scope": {
      "id": "7c5dae5552338874e5053f2534d2767a",
      "email": "user@example.com",
      "type": "user"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  firewall-access-rule-for-a-zone-delete-access-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete Access Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Remove an access rule so it is no longer evaluated during requests. Optionally, specify how to delete rules that match the mode and configuration across all other zones that this zone owner manages. 'none' is the default, and will only delete this rule. 'basic' will delete rules that match the same mode and configuration. 'aggressive' will delete rules that match the same configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE zones/:zone_id/firewall/access_rules/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cascade
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The level to attempt to delete rules defined on other zones that are similar to this rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "none"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: none
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: none, basic, aggressive
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/access_rules/rules/92f17202ed8bd63d69a66b86a49a8f6b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"cascade":"none"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "92f17202ed8bd63d69a66b86a49a8f6b"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WAF Rule Packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Web application firewall rule package applied to a zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Web application firewall rule packages are collections of rule groups.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-packages-list-firewall-packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Firewall Packages 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Retrieve firewall packages for a zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/firewall/waf/packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of the firewall package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "USER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of packages per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  order
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Field to order packages by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "status"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Direction to order packages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages?name=USER&page=1&per_page=50&order=status&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-packages-firewall-package-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Firewall Package Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get information about a single firewall package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/firewall/waf/packages/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-packages-edit-firewall-package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Edit Firewall Package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Change the sensitivity and action for an anomaly detection type WAF rule package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH zones/:zone_identifier/firewall/waf/packages/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sensitivity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The sensitivity of the firewall package.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "high"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: high
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: high, medium, low, off
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  action_mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The default action that will be taken for rules under the firewall package.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: simulate, block, challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"sensitivity":"high","action_mode":"challenge"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "name": "OWASP ModSecurity Core Rule Set",
    "description": "Covers OWASP Top 10 vulnerabilities, and more.",
    "detection_mode": "anomaly",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "status": "active",
    "sensitivity": "high",
    "action_mode": "challenge"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WAF Rule Groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A group of web application firewall rules that share common functionality and traits
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-groups-list-rule-groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Rule Groups 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search, list, and sort rule groups contained within a package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/firewall/waf/packages/:package_identifier/groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name of the firewall rule group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Project Honey Pot"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether or not the rules contained within this group are configurable/usable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "on"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: on, off
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rules_count
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  How many rules are contained within this group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of groups per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  order
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Field to order groups by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "mode"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: mode, rules_count
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Direction to order groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/groups?name=Project Honey Pot&mode=on&rules_count=10&page=1&per_page=50&order=mode&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "de677e5818985db1285d0e80225f06e5",
      "name": "Project Honey Pot",
      "description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
      "rules_count": 10,
      "modified_rules_count": 2,
      "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
      "mode": "on",
      "allowed_modes": [
        "on",
        "off"
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-groups-rule-group-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Rule Group Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get a single rule group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/firewall/waf/packages/:package_identifier/groups/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/groups/de677e5818985db1285d0e80225f06e5" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "de677e5818985db1285d0e80225f06e5",
    "name": "Project Honey Pot",
    "description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
    "rules_count": 10,
    "modified_rules_count": 2,
    "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "mode": "on",
    "allowed_modes": [
      "on",
      "off"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rule-groups-edit-rule-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Edit Rule Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update the state of a rule group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH zones/:zone_identifier/firewall/waf/packages/:package_identifier/groups/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether or not the rules contained within this group are configurable/usable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "on"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: on, off
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/groups/de677e5818985db1285d0e80225f06e5" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"on"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "de677e5818985db1285d0e80225f06e5",
    "name": "Project Honey Pot",
    "description": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks",
    "rules_count": 10,
    "modified_rules_count": 2,
    "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "mode": "on",
    "allowed_modes": [
      "on",
      "off"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WAF Rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A firewall rule for a zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rules-list-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search, sort, and filter rules within a package
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_id/firewall/waf/packages/:package_id/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The setting a rule has been overridden to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "CHL"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: DIS, CHL, BLK, SIM
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The order in which the individual rule is executed within the related group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to match all search requirements or at least one (any)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: any, all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  order
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Field to order rules by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "status"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: priority, group_id, description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of rules per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  group_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WAF group identifier tag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "de677e5818985db1285d0e80225f06e5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Public description of the rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "SQL injection prevention for SELECT statements"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Direction to order rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/rules?description=SQL injection prevention for SELECT statements&mode=CHL&priority=5&group_id=de677e5818985db1285d0e80225f06e5&page=1&per_page=50&order=status&direction=desc&match=all" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f939de3be84e66e757adcdcb87908023",
      "description": "SQL injection prevention for SELECT statements",
      "priority": 5,
      "group": {
        "id": "de677e5818985db1285d0e80225f06e5",
        "name": "Project Honey Pot"
      },
      "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
      "allowed_modes": [
        "on",
        "off"
      ],
      "mode": "on"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rules-rule-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Rule Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Individual information about a rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_id/firewall/waf/packages/:package_id/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/rules/f939de3be84e66e757adcdcb87908023" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f939de3be84e66e757adcdcb87908023",
    "description": "SQL injection prevention for SELECT statements",
    "priority": 5,
    "group": {
      "id": "de677e5818985db1285d0e80225f06e5",
      "name": "Project Honey Pot"
    },
    "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "allowed_modes": [
      "on",
      "off"
    ],
    "mode": "on"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-rules-edit-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Edit Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update the action the rule will perform if triggered on the zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH zones/:zone_id/firewall/waf/packages/:package_id/rules/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The mode to use when the rule is triggered. Value is restricted based on the allowed_modes of the rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "on"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: default, disable, simulate, block, challenge, on, off
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/packages/a25a9a7e9c00afc1fb2e0245519d725b/rules/f939de3be84e66e757adcdcb87908023" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"mode":"on"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f939de3be84e66e757adcdcb87908023",
    "description": "SQL injection prevention for SELECT statements",
    "priority": 5,
    "group": {
      "id": "de677e5818985db1285d0e80225f06e5",
      "name": "Project Honey Pot"
    },
    "package_id": "a25a9a7e9c00afc1fb2e0245519d725b",
    "allowed_modes": [
      "on",
      "off"
    ],
    "mode": "on"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Waf Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides for turning WAF packages on or off
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-overrides-list-uri-controlled-waf-configurations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List URI-controlled WAF configurations 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List the WAF configurations on a zone.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/firewall/waf/overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of WAF configurations per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides?page=1&per_page=50" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "de677e5818985db1285d0e80225f06e5",
      "description": "Enable Cloudflare Magento ruleset for shop.example.com",
      "urls": [
        "shop.example.com/*"
      ],
      "priority": 1,
      "groups": {
        "ea8687e59929c1fd05ba97574ad43f77": "default"
      },
      "rules": {
        "100015": "disable"
      },
      "rewrite_action": {
        "default": "block",
        "challenge": "block",
        "simulate": "disable"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-overrides-create-a-uri-controlled-waf-configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create a URI-controlled WAF configuration 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create a new WAF configuration for a zone. See the record object definitions for required attributes for each record type.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST zones/:zone_identifier/firewall/waf/overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  urls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  "shop.example.com/*"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether this package is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A note that you can use to describe the purpose of this configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Enable Cloudflare Magento ruleset for shop.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Relative priority of this configuration when multiple configurations match a single URL. Higher priority configurations may overwrite values set by lower priority configurations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:-1000000000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max value:1000000000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Enable or disable WAF rule groups. The keys of this object are WAF rule group IDs and the values must be a valid WAF action (usually default or disable). When creating a new URI-controlled WAF configuration either groups or rules must be provided at a minimum.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "ea8687e59929c1fd05ba97574ad43f77": "default"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Change the action assigned to a WAF rule. The keys of this object are WAF rule IDs and the values must be a valid WAF action. Unless disabling the rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-controlled WAF configuration either groups or rules must be provided at a minimum.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "100015": "disable"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rewrite_action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        When a WAF rule matches, substitute its configured action for a different action specified by this object.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "default": "block",
  "challenge": "block",
  "simulate": "disable"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Enable Cloudflare Magento ruleset for shop.example.com","urls":["shop.example.com/*"],"priority":1,"groups":{"ea8687e59929c1fd05ba97574ad43f77":"default"},"rules":{"100015":"disable"},"rewrite_action":{"default":"block","challenge":"block","simulate":"disable"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "de677e5818985db1285d0e80225f06e5",
    "description": "Enable Cloudflare Magento ruleset for shop.example.com",
    "urls": [
      "shop.example.com/*"
    ],
    "priority": 1,
    "groups": {
      "ea8687e59929c1fd05ba97574ad43f77": "default"
    },
    "rules": {
      "100015": "disable"
    },
    "rewrite_action": {
      "default": "block",
      "challenge": "block",
      "simulate": "disable"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          waf-overrides-uri-controlled-waf-configuration-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET URI-controlled WAF configuration details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:zone_identifier/firewall/waf/overrides/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides/de677e5818985db1285d0e80225f06e5" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "de677e5818985db1285d0e80225f06e5",
    "description": "Enable Cloudflare Magento ruleset for shop.example.com",
    "urls": [
      "shop.example.com/*"
    ],
    "priority": 1,
    "groups": {
      "ea8687e59929c1fd05ba97574ad43f77": "default"
    },
    "rules": {
      "100015": "disable"
    },
    "rewrite_action": {
      "default": "block",
      "challenge": "block",
      "simulate": "disable"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          waf-overrides-update-uri-controlled-waf-configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update URI-controlled WAF configuration 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT zones/:zone_identifier/firewall/waf/overrides/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          urls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  "shop.example.com/*"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Change the action assigned to a WAF rule. The keys of this object are WAF rule IDs and the values must be a valid WAF action. Unless disabling the rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-controlled WAF configuration either groups or rules must be provided at a minimum.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "100015": "disable"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rewrite_action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              When a WAF rule matches, substitute its configured action for a different action specified by this object.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "default": "block",
  "challenge": "block",
  "simulate": "disable"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Whether this package is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A note that you can use to describe the purpose of this configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Enable Cloudflare Magento ruleset for shop.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Relative priority of this configuration when multiple configurations match a single URL. Higher priority configurations may overwrite values set by lower priority configurations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • min value:-1000000000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max value:1000000000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enable or disable WAF rule groups. The keys of this object are WAF rule group IDs and the values must be a valid WAF action (usually default or disable). When creating a new URI-controlled WAF configuration either groups or rules must be provided at a minimum.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "ea8687e59929c1fd05ba97574ad43f77": "default"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides/de677e5818985db1285d0e80225f06e5" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Enable Cloudflare Magento ruleset for shop.example.com","urls":["shop.example.com/*"],"priority":1,"groups":{"ea8687e59929c1fd05ba97574ad43f77":"default"},"rules":{"100015":"disable"},"rewrite_action":{"default":"block","challenge":"block","simulate":"disable"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "de677e5818985db1285d0e80225f06e5",
    "description": "Enable Cloudflare Magento ruleset for shop.example.com",
    "urls": [
      "shop.example.com/*"
    ],
    "priority": 1,
    "groups": {
      "ea8687e59929c1fd05ba97574ad43f77": "default"
    },
    "rules": {
      "100015": "disable"
    },
    "rewrite_action": {
      "default": "block",
      "challenge": "block",
      "simulate": "disable"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waf-overrides-delete-uri-controlled-waf-configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete URI-controlled WAF configuration 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE zones/:zone_identifier/firewall/waf/overrides/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/waf/overrides/de677e5818985db1285d0e80225f06e5" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "result": {
    "id": "de677e5818985db1285d0e80225f06e5"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Waf Overrides error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10001lockdown rule not found
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10002lockdown rule not unique (edit the existing rather than adding a new)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10004Invalid data submitted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10006Auth missing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10007Auth corrupt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10008Auth expired
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10009Unauthorized
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10011Pagination results in empty page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10013Patch values not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10014Patch operation not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10015Patch value not valid for given context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10016Patch not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  User-Agent Blocking Rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Perform access control when matching the exact UserAgent reported by the client
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The access control mechanisms can be defined within a rule to help manage traffic from particular clients.
This will enable you to customise the access to your site. The mechanisms are: -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  block - Blocks the request immediately
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  challenge - Send a challenge to the originator of the request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  js_challenge - Send a JavaScript based challenge to the originator of the request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  user-agent-blocking-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  user-agent-blocking-rules-list-useragent-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List UserAgent Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List the UserAgent rules on a zone.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/firewall/ua_rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A single string to search for in the description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "abusive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    user_agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A single UserAgent string to search for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Safari"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules?page=1&per_page=20&description=abusive&user_agent=Safari" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b59",
      "paused": false,
      "description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
      "mode": "js_challenge",
      "configuration": {
        "target": "ua",
        "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      user-agent-blocking-rules-create-useragent-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create UserAgent Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a new UserAgent rule for a zone. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST zones/:zone_identifier/firewall/ua_rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The type of action to perform.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "js_challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 12
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: block, challenge, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Target/Value pair to use for this rule. The value is the exact UserAgent to match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "target": "ua",
  "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UA rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "372e67954025e0ba6aaa6d586b9e0b59"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether this UA rule is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Some useful information about this rule to help identify the purpose of it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","paused":false,"description":"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack","mode":"js_challenge","configuration":{"target":"ua","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "paused": false,
    "description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
    "mode": "js_challenge",
    "configuration": {
      "target": "ua",
      "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        user-agent-blocking-rules-useragent-rule-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET UserAgent Rule Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List one user agent rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/firewall/ua_rules/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "paused": false,
    "description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
    "mode": "js_challenge",
    "configuration": {
      "target": "ua",
      "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        user-agent-blocking-rules-update-useragent-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update UserAgent Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT zones/:zone_identifier/firewall/ua_rules/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UA rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "372e67954025e0ba6aaa6d586b9e0b59"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The type of action to perform.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "js_challenge"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 12
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: block, challenge, js_challenge
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Target/Value pair to use for this rule. The value is the exact UserAgent to match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "target": "ua",
  "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether this UA rule is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Some useful information about this rule to help identify the purpose of it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b59","paused":false,"description":"Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack","mode":"js_challenge","configuration":{"target":"ua","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "paused": false,
    "description": "Prevent access from abusive clients identified by this UserAgent to mitigate DDoS attack",
    "mode": "js_challenge",
    "configuration": {
      "target": "ua",
      "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          user-agent-blocking-rules-delete-useragent-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE Delete UserAgent Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE zones/:zone_identifier/firewall/ua_rules/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/ua_rules/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          User-Agent Blocking Rules error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10001UserAgent rule not found
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10002UserAgent rule not unique (edit the existing rather than adding a new)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10004Invalid data submitted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10006Auth missing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10007Auth corrupt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10008Auth expired
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10009Unauthorized
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10011Pagination results in empty page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10013Patch values not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10014Patch operation not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10015Patch value not valid for given context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10016Patch not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Zone Lockdown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Lock access to URLs in this zone to only permitted addresses or address ranges.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ensure that part(s) of your site can only be accessed from permitted IP addresses or IP ranges. Zone Lockdown allows you to define one or more URLs (with wildcard matching on the domain or path) that will only permit access if the request originates from an IP address that matches a safelist of one or more IP addresses and/or IP ranges.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-lockdown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-lockdown-list-lockdown-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Lockdown Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List the lockdown rules on a zone.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:zone_identifier/firewall/lockdowns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ip_range
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A single IP range to search for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "1.2.3.0/16"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A single IP address to search for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "1.2.3.4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                uri
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A single URI to search for in the list of URLs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "/some/path"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Maximum number of results per page. This can only be provided as 1 or in multiples of 5 such as 5, 10, 15 or 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  modified_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When the lockdown rule was modified
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2014-01-01T05:20:00.12345Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  created_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  When the lockdown rule was created
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2014-01-01T05:20:00.12345Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A single string to search for in the description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "endpoints"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns?page=1&per_page=20&description=endpoints&created_on=2014-01-01T05:20:00.12345Z&modified_on=2014-01-01T05:20:00.12345Z&uri=/some/path&ip=1.2.3.4&ip_range=1.2.3.0/16&priority=5" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b59",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "paused": false,
      "description": "Restrict access to these endpoints to requests from a known IP address",
      "urls": [
        "api.mysite.com/some/endpoint*"
      ],
      "configurations": [
        {
          "target": "ip",
          "value": "198.51.100.4"
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zone-lockdown-create-lockdown-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create Lockdown Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a new lockdown rule for a zone. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST zones/:zone_identifier/firewall/lockdowns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    urls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns. 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  "api.mysite.com/some/endpoint*"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      configurations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List of IP addresses or CIDR ranges to use for this rule. This can include any number of ip or ip_range configurations that can access the provided URLs.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "target": "ip",
    "value": "198.51.100.4"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Any of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether this zone lockdown is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A note that you can use to describe the reason for a Lockdown rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Restrict access to these endpoints to requests from a known IP address"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"paused":false,"description":"Restrict access to these endpoints to requests from a known IP address","urls":["api.mysite.com/some/endpoint*"],"configurations":[{"target":"ip","value":"198.51.100.4"}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "paused": false,
    "description": "Restrict access to these endpoints to requests from a known IP address",
    "urls": [
      "api.mysite.com/some/endpoint*"
    ],
    "configurations": [
      {
        "target": "ip",
        "value": "198.51.100.4"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zone-lockdown-lockdown-rule-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Lockdown Rule Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/firewall/lockdowns/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "paused": false,
    "description": "Restrict access to these endpoints to requests from a known IP address",
    "urls": [
      "api.mysite.com/some/endpoint*"
    ],
    "configurations": [
      {
        "target": "ip",
        "value": "198.51.100.4"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zone-lockdown-update-lockdown-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Lockdown Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT zones/:zone_identifier/firewall/lockdowns/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        urls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        URLs to be included in this rule definition. Wildcards are permitted. The URL pattern entered here will be escaped before use. This limits the URL to just simple wildcard patterns. 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  "api.mysite.com/some/endpoint*"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          configurations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of IP addresses or CIDR ranges to use for this rule. This can include any number of ip or ip_range configurations that can access the provided URLs.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "target": "ip",
    "value": "198.51.100.4"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Any of the following:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether this zone lockdown is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A note that you can use to describe the reason for a Lockdown rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Restrict access to these endpoints to requests from a known IP address"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 1024
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"paused":false,"description":"Restrict access to these endpoints to requests from a known IP address","urls":["api.mysite.com/some/endpoint*"],"configurations":[{"target":"ip","value":"198.51.100.4"}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "paused": false,
    "description": "Restrict access to these endpoints to requests from a known IP address",
    "urls": [
      "api.mysite.com/some/endpoint*"
    ],
    "configurations": [
      {
        "target": "ip",
        "value": "198.51.100.4"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-lockdown-delete-lockdown-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Lockdown Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:zone_identifier/firewall/lockdowns/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/lockdowns/372e67954025e0ba6aaa6d586b9e0b59" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Zone Lockdown error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10001lockdown rule not found
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10002lockdown rule not unique (edit the existing rather than adding a new)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10004Invalid data submitted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10006Auth missing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10007Auth corrupt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10008Auth expired
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10009Unauthorized
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10011Pagination results in empty page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10013Patch values not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10014Patch operation not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10015Patch value not valid for given context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10016Patch not valid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Firewall rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Define Firewall rules using filter expressions for more control over how traffic is matched to the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A filter expression permits selecting traffic by multiple criteria allowing greater freedom in rule creation. An in-depth documentation can be found at https://developers.cloudflare.com/firewall/cf-firewall-rules/
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-rules-list-of-firewall-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List of firewall rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List all the firewall rules currently defined.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/firewall/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Firewall Rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "372e67954025e0ba6aaa6d586b9e0b60"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Case-insensitive search in description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "mir"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Exact match on a rule action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "block"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Whether this firewall rule is currently paused.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Number of firewall rules per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules?id=372e67954025e0ba6aaa6d586b9e0b60&description=mir&action=block&paused=false&page=1&per_page=25" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b60",
      "action": "block",
      "products": [
        "waf"
      ],
      "priority": 50,
      "paused": false,
      "description": "Blocks traffic identified during investigation for MIR-31",
      "ref": "MIR-31",
      "filter": {
        "id": "372e67954025e0ba6aaa6d586b9e0b61",
        "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
        "paused": false,
        "description": "Restrict access from these browsers on this address range.",
        "ref": "FIL-100"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                firewall-rules-get-individual-firewall-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Get individual Firewall Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Retrieve the properties of an individual firewall rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:zone_identifier/firewall/rules/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Firewall Rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "372e67954025e0ba6aaa6d586b9e0b60"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules/372e67954025e0ba6aaa6d586b9e0b60?id=372e67954025e0ba6aaa6d586b9e0b60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b60",
    "action": "block",
    "products": [
      "waf"
    ],
    "priority": 50,
    "paused": false,
    "description": "Blocks traffic identified during investigation for MIR-31",
    "ref": "MIR-31",
    "filter": {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                firewall-rules-create-firewall-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create firewall rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create new firewall rules. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST zones/:zone_identifier/firewall/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The action to apply to a matched request. Note that action "log" is only available for enterprise customers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "block"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: block, challenge, js_challenge, allow, log, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "id": "372e67954025e0ba6aaa6d586b9e0b61",
  "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
  "paused": false,
  "description": "Restrict access from these browsers on this address range.",
  "ref": "FIL-100"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Firewall Rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "372e67954025e0ba6aaa6d586b9e0b60"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  products
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  "waf"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether this firewall rule is currently paused.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A description of the rule to help identify it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Blocks traffic identified during investigation for MIR-31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Short reference tag to quickly select related rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "MIR-31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"id":"372e67954025e0ba6aaa6d586b9e0b60","action":"block","products":["waf"],"priority":50,"paused":false,"description":"Blocks traffic identified during investigation for MIR-31","ref":"MIR-31","filter":{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b60",
      "action": "block",
      "products": [
        "waf"
      ],
      "priority": 50,
      "paused": false,
      "description": "Blocks traffic identified during investigation for MIR-31",
      "ref": "MIR-31",
      "filter": {
        "id": "372e67954025e0ba6aaa6d586b9e0b61",
        "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
        "paused": false,
        "description": "Restrict access from these browsers on this address range.",
        "ref": "FIL-100"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    firewall-rules-update-firewall-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update firewall rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update existing firewall rules. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT zones/:zone_identifier/firewall/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Firewall Rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "372e67954025e0ba6aaa6d586b9e0b60"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The action to apply to a matched request. Note that action "log" is only available for enterprise customers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "block"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: block, challenge, js_challenge, allow, log, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    products
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  "waf"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether this firewall rule is currently paused.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A description of the rule to help identify it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Blocks traffic identified during investigation for MIR-31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Short reference tag to quickly select related rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "MIR-31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "id": "372e67954025e0ba6aaa6d586b9e0b61",
  "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
  "paused": false,
  "description": "Restrict access from these browsers on this address range.",
  "ref": "FIL-100"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"id":"372e67954025e0ba6aaa6d586b9e0b60","action":"block","products":["waf"],"priority":50,"paused":false,"description":"Blocks traffic identified during investigation for MIR-31","ref":"MIR-31","filter":{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b60",
      "action": "block",
      "products": [
        "waf"
      ],
      "priority": 50,
      "paused": false,
      "description": "Blocks traffic identified during investigation for MIR-31",
      "ref": "MIR-31",
      "filter": {
        "id": "372e67954025e0ba6aaa6d586b9e0b61",
        "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
        "paused": false,
        "description": "Restrict access from these browsers on this address range.",
        "ref": "FIL-100"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        firewall-rules-update-individual-firewall-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update individual firewall rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update an individual existing firewall rule. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT zones/:zone_identifier/firewall/rules/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Firewall Rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "372e67954025e0ba6aaa6d586b9e0b60"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The action to apply to a matched request. Note that action "log" is only available for enterprise customers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "block"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: block, challenge, js_challenge, allow, log, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "id": "372e67954025e0ba6aaa6d586b9e0b61",
  "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
  "paused": false,
  "description": "Restrict access from these browsers on this address range.",
  "ref": "FIL-100"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          products
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  "waf"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The priority of the rule to allow control of processing order. A lower number indicates high priority. If not provided, any rules with a priority will be sequenced before those without.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether this firewall rule is currently paused.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A description of the rule to help identify it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Blocks traffic identified during investigation for MIR-31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Short reference tag to quickly select related rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "MIR-31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules/372e67954025e0ba6aaa6d586b9e0b60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b60","action":"block","products":["waf"],"priority":50,"paused":false,"description":"Blocks traffic identified during investigation for MIR-31","ref":"MIR-31","filter":{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b60",
    "action": "block",
    "products": [
      "waf"
    ],
    "priority": 50,
    "paused": false,
    "description": "Blocks traffic identified during investigation for MIR-31",
    "ref": "MIR-31",
    "filter": {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-rules-delete-firewall-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete firewall rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete existing firewall rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:zone_identifier/firewall/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Firewall Rule identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "372e67954025e0ba6aaa6d586b9e0b60"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b60"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b60",
      "action": "block",
      "products": [
        "waf"
      ],
      "priority": 50,
      "paused": false,
      "description": "Blocks traffic identified during investigation for MIR-31",
      "ref": "MIR-31",
      "filter": {
        "id": "372e67954025e0ba6aaa6d586b9e0b61",
        "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
        "paused": false,
        "description": "Restrict access from these browsers on this address range.",
        "ref": "FIL-100"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            firewall-rules-delete-individual-firewall-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete individual firewall rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete existing firewall rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:zone_identifier/firewall/rules/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            delete_filter_if_unused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If true and the filter is not referenced by any other rule, also delete the filter.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/firewall/rules/372e67954025e0ba6aaa6d586b9e0b60" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b60",
    "action": "block",
    "products": [
      "waf"
    ],
    "priority": 50,
    "paused": false,
    "description": "Blocks traffic identified during investigation for MIR-31",
    "ref": "MIR-31",
    "filter": {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Firewall rules error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Filter expressions that can be referenced across multiple features
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A filter is an expression that can be referenced across multiple APIs. Currently, the only API that uses filters is Firewall Rules API. An in-depth documentation can be found at https://developers.cloudflare.com/firewall/cf-firewall-rules/
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filters-list-filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List filters 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List all the filters currently defined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Filter identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "372e67954025e0ba6aaa6d586b9e0b61"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether this filter is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Case-insensitive string to find in expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "php"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Case-insensitive string to find in description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "browsers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Exact match search on a ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "FIL-100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of filter based firewall rules per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters?id=372e67954025e0ba6aaa6d586b9e0b61&paused=false&expression=php&description=browsers&ref=FIL-100&page=1&per_page=25" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filters-list-individual-filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List individual filter 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List one filters currently defined
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/filters/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters/372e67954025e0ba6aaa6d586b9e0b61" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b61",
    "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
    "paused": false,
    "description": "Restrict access from these browsers on this address range.",
    "ref": "FIL-100"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filters-create-filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Filters 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create new filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST zones/:zone_identifier/filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The filter expression to be used
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Filter identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "372e67954025e0ba6aaa6d586b9e0b61"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether this filter is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A note that you can use to describe the purpose of the filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Restrict access from these browsers on this address range."
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Short reference tag to quickly select related rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "FIL-100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filters-update-filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update filters 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update existing filters. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT zones/:zone_identifier/filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Filter identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "372e67954025e0ba6aaa6d586b9e0b61"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The filter expression to be used
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Whether this filter is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A note that you can use to describe the purpose of the filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Restrict access from these browsers on this address range."
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Short reference tag to quickly select related rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "FIL-100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      filters-update-individual-filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update individual filter 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update an existing filter. See the record object definitions for required attributes for each record type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:zone_identifier/filters/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Filter identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "372e67954025e0ba6aaa6d586b9e0b61"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expression
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The filter expression to be used
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Whether this filter is currently paused
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A note that you can use to describe the purpose of the filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Restrict access from these browsers on this address range."
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ref
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Short reference tag to quickly select related rules.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "FIL-100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters/372e67954025e0ba6aaa6d586b9e0b61" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b61","expression":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","paused":false,"description":"Restrict access from these browsers on this address range.","ref":"FIL-100"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b61",
    "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
    "paused": false,
    "description": "Restrict access from these browsers on this address range.",
    "ref": "FIL-100"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filters-delete-filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE Delete filters 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete existing filters.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE zones/:zone_identifier/filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Filter identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "372e67954025e0ba6aaa6d586b9e0b61"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"372e67954025e0ba6aaa6d586b9e0b61"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "description": "Restrict access from these browsers on this address range.",
      "ref": "FIL-100"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filters-delete-individual-filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE Delete individual filter 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete existing filters.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE zones/:zone_identifier/filters/:id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/filters/372e67954025e0ba6aaa6d586b9e0b61" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b61",
    "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
    "paused": false,
    "description": "Restrict access from these browsers on this address range.",
    "ref": "FIL-100"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Filters error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Rules Lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Lists of IPs and CIDRs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Lists are designed to enable more powerful expressions in filters.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists-list-lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET List Lists 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List all Lists for the account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/rules/lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
      "name": "list1",
      "description": "This is a note.",
      "kind": "ip",
      "num_items": 10,
      "num_referencing_filters": 2,
      "created_on": "2020-01-01T08:00:00Z",
      "modified_on": "2020-01-10T14:00:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists-create-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST Create List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a new list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST accounts/:account_identifier/rules/lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The name of the list (used in filter expressions).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "list1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pattern: ^[a-zA-Z0-9_]+$
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        kind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The kind of values in the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "ip"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A note that can be used to annotate the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "This is a note."
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"list1","description":"This is a note.","kind":"ip"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "name": "list1",
    "description": "This is a note.",
    "kind": "ip",
    "num_items": 10,
    "num_referencing_filters": 2,
    "created_on": "2020-01-01T08:00:00Z",
    "modified_on": "2020-01-10T14:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists-get-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Get List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get the List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/rules/lists/:list_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "name": "list1",
    "description": "This is a note.",
    "kind": "ip",
    "num_items": 10,
    "num_referencing_filters": 2,
    "created_on": "2020-01-01T08:00:00Z",
    "modified_on": "2020-01-10T14:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists-update-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update the list description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT accounts/:account_identifier/rules/lists/:list_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A note that can be used to annotate the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "This is a note."
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"This is a note."}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "name": "list1",
    "description": "This is a note.",
    "kind": "ip",
    "num_items": 10,
    "num_referencing_filters": 2,
    "created_on": "2020-01-01T08:00:00Z",
    "modified_on": "2020-01-10T14:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists-delete-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE Delete List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete the list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE accounts/:account_identifier/rules/lists/:list_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "34b12448945f11eaa1b71c4d701ab86e"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules-lists-list-list-items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET List List Items 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List all items in the List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/rules/lists/:list_id/items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cursor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The pagination cursor. These are provided under result_info.cursors. No assumptions should be made about its content or its length.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "zzz"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e/items?cursor=zzz" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
      "ip": "10.0.0.1",
      "comment": "Private IP address",
      "created_on": "2020-01-01T08:00:00Z",
      "modified_on": "2020-01-10T14:00:00Z"
    }
  ],
  "result_info": {
    "cursors": {
      "before": "xxx",
      "after": "yyy"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rules-lists-create-list-items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create List Items 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Append new items to the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This endpoint is asynchronous. The result is available by polling the Get Bulk Operation endpoint with the returned operation_id.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST accounts/:account_identifier/rules/lists/:list_id/items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The IPv4 address, IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "10.0.0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            comment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A note that can be used to annotate the item.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Private IP address"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e/items" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"ip":"10.0.0.1","comment":"Private IP address"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "operation_id": "4da8780eeb215e6cb7f48dd981c4ea02"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rules-lists-replace-list-items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT Replace List Items 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Remove all current list items and append the given items to the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This endpoint is asynchronous. The result is available by polling the Get Bulk Operation endpoint with the returned operation_id.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT accounts/:account_identifier/rules/lists/:list_id/items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The IPv4 address, IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "10.0.0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                comment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A note that can be used to annotate the item.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Private IP address"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e/items" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"ip":"10.0.0.1","comment":"Private IP address"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "operation_id": "4da8780eeb215e6cb7f48dd981c4ea02"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rules-lists-delete-list-items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete List Items 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete one or more items in a List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This endpoint is asynchronous. The result is available by polling the Get Bulk Operation endpoint with the returned operation_id.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE accounts/:account_identifier/rules/lists/:list_id/items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "id": "34b12448945f11eaa1b71c4d701ab86e"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min items: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e/items" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"items":[{"id":"34b12448945f11eaa1b71c4d701ab86e"}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "operation_id": "4da8780eeb215e6cb7f48dd981c4ea02"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rules-lists-get-list-item
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Get List Item 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get an item in the List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/rules/lists/:list_id/items/:item_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/2c0fc9fa937b11eaa1b71c4d701ab86e/items/34b12448945f11eaa1b71c4d701ab86e" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
    "ip": "10.0.0.1",
    "comment": "Private IP address",
    "created_on": "2020-01-01T08:00:00Z",
    "modified_on": "2020-01-10T14:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rules-lists-get-bulk-operation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Get Bulk Operation 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the current status of a Lists asynchronous operation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If the operation has failed then an error message will be available in the response.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/rules/lists/bulk_operations/:operation_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rules/lists/bulk_operations/4da8780eeb215e6cb7f48dd981c4ea02" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "4da8780eeb215e6cb7f48dd981c4ea02",
    "status": "failed",
    "error": "This list is at the maximum number of items",
    "completed": "2020-01-01T08:00:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Rules Lists error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Account rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Account-level rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-rulesets-list-account-rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List account rulesets 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List all rulesets for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_id/rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The ID of the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2f2feab2026849078ba485f918791bdc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The human readable name for the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "My Magic Transit ruleset"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The description of the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      kind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The kind of ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "root"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: custom, managed, root, schema, zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The version of the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        last_updated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The timestamp of the last ruleset execution
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          shareable_entitlement_name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            phase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The phase when the ruleset is executed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: ddos_l4, ddos_l7, magic_transit, http_request_sanitize, http_request_transform, http_request_firewall_custom, http_ratelimit, http_request_firewall_managed, http_request_late_transform, http_response_firewall_managed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets?0=[object Object]" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-create-account-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create account ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create an account ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST accounts/:account_id/rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "rules": [
    {
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-get-an-account-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Get an account ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get an account ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_id/rulesets/:ruleset_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "id": "2f2feab2026849078ba485f918791bdc",
  "name": "My Magic Transit ruleset",
  "kind": "root",
  "phase": "phase_magic_transit",
  "rules": [
    {
      "id": "3a03d665bac047339bb530ecb439a90d",
      "version": "1",
      "action": "block",
      "expression": "not ip.src in {10.20.30.40}",
      "description": "Block all traffic except 10.20.30.40",
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-list-versions-of-an-account-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List versions of an account ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List versions of an account ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_id/rulesets/:ruleset_id/versions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined/versions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-get-an-account-ruleset-version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Get an account ruleset version 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get an account ruleset version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_id/rulesets/:ruleset_id/versions/:ruleset_version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined/versions/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "rules": [
    {}
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-delete-account-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete account ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete all versions of the account ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_id/rulesets/:ruleset_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-delete-a-version-of-an-account-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete a version of an account ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete a version of an account ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_id/rulesets/:ruleset_id/versions/:ruleset_version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined/versions/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-update-account-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update account ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update an existing account ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT accounts/:account_id/rulesets/:ruleset_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "rules": [
    {
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-get-entrypoint-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Get entrypoint ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get entrypoint ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/phases/undefined/entrypoint" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "id": "2f2feab2026849078ba485f918791bdc",
  "name": "My Magic Transit ruleset",
  "kind": "root",
  "phase": "phase_magic_transit",
  "rules": [
    {
      "id": "3a03d665bac047339bb530ecb439a90d",
      "version": "1",
      "action": "block",
      "expression": "not ip.src in {10.20.30.40}",
      "description": "Block all traffic except 10.20.30.40",
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-update-entrypoint-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update entrypoint ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update or create entrypoint ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/phases/undefined/entrypoint" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "rules": [
    {
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-get-an-entrypoint-ruleset-version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Get an entrypoint ruleset version 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Get an entrypoint ruleset version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint/versions/:ruleset_version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/phases/undefined/entrypoint/versions/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "rules": [
    {}
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-list-versions-of-an-entrypoint-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List versions of an entrypoint ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List versions of an entrypoint ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_id/rulesets/phases/:ruleset_phase/entrypoint/versions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/phases/undefined/entrypoint/versions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-add-an-individual-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Add an individual rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Add a new individual rule a the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST accounts/:account_id/rulesets/:ruleset_id/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-patch-an-individual-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PATCH Patch an individual rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Patch an individual rule in a ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PATCH accounts/:account_id/rulesets/:ruleset_id/rules/:rule_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined/rules/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            account-rulesets-delete-an-individual-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete an individual rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete an individual rule from a ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:account_id/rulesets/:ruleset_id/rules/:rule_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/rulesets/undefined/rules/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Zone rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Zone-level rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-rulesets-list-zone-rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List zone rulesets 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List all rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_id/rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The ID of the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "2f2feab2026849078ba485f918791bdc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The human readable name for the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "My Magic Transit ruleset"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The description of the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                kind
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The kind of ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "root"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: custom, managed, root, schema, zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The version of the ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  last_updated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The timestamp of the last ruleset execution
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    shareable_entitlement_name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      phase
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The phase when the ruleset is executed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: ddos_l4, ddos_l7, magic_transit, http_request_sanitize, http_request_transform, http_request_firewall_custom, http_ratelimit, http_request_firewall_managed, http_request_late_transform, http_response_firewall_managed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets?0=[object Object]" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-create-zone-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create zone ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a zone ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST zones/:zone_id/rulesets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "rules": [
    {
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-get-a-zone-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get a zone ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get a zone ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/rulesets/:ruleset_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "id": "2f2feab2026849078ba485f918791bdc",
  "name": "My Magic Transit ruleset",
  "kind": "root",
  "phase": "phase_magic_transit",
  "rules": [
    {
      "id": "3a03d665bac047339bb530ecb439a90d",
      "version": "1",
      "action": "block",
      "expression": "not ip.src in {10.20.30.40}",
      "description": "Block all traffic except 10.20.30.40",
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-get-a-zone-ruleset-version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get a zone ruleset version 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get a zone ruleset version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/rulesets/:ruleset_id/versions/:ruleset_version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/undefined/versions/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "rules": [
    {}
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-delete-zone-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete zone ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete all versions of the zone ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE zones/:zone_id/rulesets/:ruleset_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-delete-a-version-of-a-zone-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete a version of a zone ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete a version of a zone ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE zones/:zone_id/rulesets/:ruleset_id/versions/:ruleset_version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/undefined/versions/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-update-a-zone-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update a zone ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update an existing zone ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:zone_id/rulesets/:ruleset_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "rules": [
    {
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-get-entrypoint-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get entrypoint ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get entrypoint ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/phases/undefined/entrypoint" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "id": "2f2feab2026849078ba485f918791bdc",
  "name": "My Magic Transit ruleset",
  "kind": "root",
  "phase": "phase_magic_transit",
  "rules": [
    {
      "id": "3a03d665bac047339bb530ecb439a90d",
      "version": "1",
      "action": "block",
      "expression": "not ip.src in {10.20.30.40}",
      "description": "Block all traffic except 10.20.30.40",
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-update-entrypoint-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update entrypoint ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update entrypoint ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/phases/undefined/entrypoint" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "rules": [
    {
      "action_parameters": {
        "products": []
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-get-an-entrypoint-ruleset-version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get an entrypoint ruleset version 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get an entrypoint ruleset version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint/versions/:ruleset_version
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/phases/undefined/entrypoint/versions/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "rules": [
    {}
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-rulesets-list-versions-of-an-entrypoint-ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List versions of an entrypoint ruleset 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List versions of an entrypoint ruleset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint/versions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/rulesets/phases/undefined/entrypoint/versions" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Script Monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Script Monitor monitors your zone for new JavaScript dependencies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      script-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      script-monitor-get-script-monitor-settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get Script Monitor settings 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the status of the Script Monitor feature
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/script_monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/script_monitor" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {}
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      script-monitor-update-script-monitor-settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update Script Monitor settings 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Set the status of the Script Monitor feature
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:zone_id/script_monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/script_monitor" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {}
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      script-monitor-list-script-monitor-scripts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Script Monitor scripts 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List all Script Monitor scripts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_id/script_monitor/scripts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exclude_script_urls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Comma separated list of URL-encoded URL substrings to exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "blog.cloudflare.com,www.example"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        script_urls
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Comma separated list of URL-encoded URL substrings to include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "blog.cloudflare.com,www.example"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hosts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Comma separated list of URL-encoded Host substrings to include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "blog.cloudflare.com,www.example"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            first_seen_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Only display results with a first seen at value greater than a specified timestamp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "2021-11-31T23:11:56"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Number of results per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max value:100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              order_by
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The order the results are returned in
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "first_seen_at"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: first_seen_at, last_seen_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Direction to order results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "asc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/script_monitor/scripts?exclude_script_urls=blog.cloudflare.com,www.example&script_urls=blog.cloudflare.com,www.example&hosts=blog.cloudflare.com,www.example&first_seen_at=2021-11-31T23:11:56&page=2&per_page=100&order_by=first_seen_at&direction=asc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "script_id": "c9ef84a6bf5e47138c75d95e2f933e8f",
      "script_url": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js",
      "added_at": "2021-08-18T10:51:10.09615Z",
      "first_seen_at": "2021-08-18T10:51:08Z",
      "last_seen_at": "2021-09-02T09:57:54Z",
      "host": "blog.cloudflare.com",
      "domain_reported_malicious": false,
      "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "js_integrity_score": 10,
      "fetched_at": "2021-09-02T10:17:54Z"
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 2000
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              script-monitor-get-a-script
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET Get a script 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get a script by ID
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET zones/:zone_id/script_monitor/scripts/:script_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/script_monitor/scripts/undefined" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "script_id": "c9ef84a6bf5e47138c75d95e2f933e8f",
  "script_url": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js",
  "added_at": "2021-08-18T10:51:10.09615Z",
  "first_seen_at": "2021-08-18T10:51:08Z",
  "last_seen_at": "2021-09-02T09:57:54Z",
  "host": "blog.cloudflare.com",
  "domain_reported_malicious": false,
  "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "js_integrity_score": 10,
  "fetched_at": "2021-09-02T10:17:54Z"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Load Balancer Monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              User-level Monitor configurations. Monitors define whether we check over HTTP, HTTPS or TCP, the status code(s) we look for, the interval at which we check, timeouts and response body matching.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              load-balancer-monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              load-balancer-monitors-list-monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET List Monitors 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List configured monitors for a user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET user/load_balancers/monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/monitors" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "type": "https",
      "description": "Login page monitor",
      "method": "GET",
      "path": "/health",
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      },
      "port": 8080,
      "timeout": 3,
      "retries": 0,
      "interval": 90,
      "expected_body": "alive",
      "expected_codes": "2xx",
      "follow_redirects": true,
      "allow_insecure": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              load-balancer-monitors-create-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              POST Create Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create a configured monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              POST user/load_balancers/monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              90
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Login page monitor"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/monitors" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      load-balancer-monitors-monitor-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Monitor Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List a single configured monitor for a user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET user/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      load-balancer-monitors-update-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Modify a configured monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT user/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      90
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Login page monitor"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              load-balancer-monitors-patch-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH Patch Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Apply changes to an existing monitor, overwriting the supplied properties.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH user/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              90
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Login page monitor"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      load-balancer-monitors-delete-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete a configured monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE user/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      load-balancer-monitors-preview-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Preview Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST user/load_balancers/monitors/:identifier/preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc/preview" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "pools": {
      "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
      "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancer-monitors-preview-result
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Preview Result 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get the result of a previous preview operation using the provided preview_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET user/load_balancers/preview/:preview_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/preview/f1aba936b94213e5b8dca0c0dbf1f9cc?" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "abwlnp5jbqn45ecgxd03erbgtxtqai0d": {
    "healthy": true,
    "origins": [
      {
        "originone.example.com.": {
          "healthy": true,
          "rtt": "66ms",
          "failure_reason": "No failures",
          "response_code": 200
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancer-monitors-list-monitor-references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Monitor References 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get the list of resources that reference the provided monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET user/load_balancers/monitors/:identifier/references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc/references" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
      "resource_name": "primary-dc-1",
      "resource_type": "pool",
      "reference_type": "referrer"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Load Balancer Pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          User-level Load Balancer Pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancer-pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancer-pools-list-pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Pools 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List configured pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET user/load_balancers/pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools?monitor=f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "17b5962d775c646f3f9725cbc7a53df4",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "description": "Primary data center - Provider XYZ",
      "name": "primary-dc-1",
      "enabled": false,
      "load_shedding": {
        "default_percent": 0,
        "default_policy": "random",
        "session_percent": 0,
        "session_policy": "hash"
      },
      "minimum_origins": 2,
      "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "check_regions": [
        "WEU",
        "ENAM"
      ],
      "origins": [
        {
          "name": "app-server-1",
          "address": "0.0.0.0",
          "enabled": true,
          "weight": 0.56,
          "header": {
            "Host": [
              "example.com"
            ]
          }
        }
      ],
      "origin_steering": {
        "policy": "random"
      },
      "notification_email": "someone@example.com,sometwo@example.com",
      "notification_filter": {
        "origin": {
          "disable": false,
          "healthy": null
        },
        "pool": {
          "disable": false,
          "healthy": null
        }
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancer-pools-create-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST user/load_balancers/pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  {
    "name": "app-server-1",
    "address": "0.0.0.0",
    "enabled": true,
    "weight": 0.56,
    "header": {
      "Host": [
        "example.com"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              notification_email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "someone@example.com,sometwo@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of regions from which to run health checks. Null means every Cloudflare datacenter.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                origin_steering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Configure origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "policy": "random"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  load_shedding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configure load shedding policies and percentages for the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "default_percent": 0,
  "default_policy": "random",
  "session_percent": 0,
  "session_policy": "hash"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    latitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The latitude of datacenter containing the origins used in this pool in decimal degrees. If this is set longitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      notification_filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Filter pool and origin health notifications by resource type or health status. Use null to reset.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "origin": {
    "disable": false,
    "healthy": null
  },
  "pool": {
    "disable": false,
    "healthy": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        longitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The longitude of datacenter containing the origins used in this pool in decimal degrees. If this is set latitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          minimum_origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A human-readable description of the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Primary data center - Provider XYZ"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/pools" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":false,"check_regions":["WEU","ENAM"],"load_shedding":{"default_percent":0,"default_policy":"random","session_percent":0,"session_policy":"hash"},"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56,"header":{"Host":["example.com"]}}],"origin_steering":{"policy":"random"},"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancer-pools-pool-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Pool Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch a single configured pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET user/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancer-pools-pool-health-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Pool Health Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch latest healthcheck details for a single pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET user/load_balancers/pools/:identifier/health
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/health" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "pop_health": {
      "Amsterdam, NL": {
        "healthy": true,
        "origins": [
          {
            "2001:DB8::5": {
              "healthy": true,
              "rtt": "12.1ms",
              "failure_reason": "No failures",
              "response_code": 401
            }
          }
        ]
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancer-pools-update-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Modify a configured pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT user/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "name": "app-server-1",
    "address": "0.0.0.0",
    "enabled": true,
    "weight": 0.56,
    "header": {
      "Host": [
        "example.com"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                notification_email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "someone@example.com,sometwo@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A list of regions from which to run health checks. Null means every Cloudflare datacenter.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  origin_steering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Configure origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "policy": "random"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    load_shedding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Configure load shedding policies and percentages for the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "default_percent": 0,
  "default_policy": "random",
  "session_percent": 0,
  "session_policy": "hash"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      latitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The latitude of datacenter containing the origins used in this pool in decimal degrees. If this is set longitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        notification_filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Filter pool and origin health notifications by resource type or health status. Use null to reset.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "origin": {
    "disable": false,
    "healthy": null
  },
  "pool": {
    "disable": false,
    "healthy": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          longitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The longitude of datacenter containing the origins used in this pool in decimal degrees. If this is set latitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            disabled_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            minimum_origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A human-readable description of the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Primary data center - Provider XYZ"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":false,"check_regions":["WEU","ENAM"],"load_shedding":{"default_percent":0,"default_policy":"random","session_percent":0,"session_policy":"hash"},"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56,"header":{"Host":["example.com"]}}],"origin_steering":{"policy":"random"},"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              load-balancer-pools-patch-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH Patch Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Apply changes to an existing pool, overwriting the supplied properties.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH user/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              notification_email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "someone@example.com,sometwo@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A list of regions from which to run health checks. Null means every Cloudflare datacenter.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                origin_steering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Configure origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "policy": "random"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    load_shedding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Configure load shedding policies and percentages for the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "default_percent": 0,
  "default_policy": "random",
  "session_percent": 0,
  "session_policy": "hash"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      latitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The latitude of datacenter containing the origins used in this pool in decimal degrees. If this is set longitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        notification_filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Filter pool and origin health notifications by resource type or health status. Use null to reset.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "origin": {
    "disable": false,
    "healthy": null
  },
  "pool": {
    "disable": false,
    "healthy": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "name": "app-server-1",
    "address": "0.0.0.0",
    "enabled": true,
    "weight": 0.56,
    "header": {
      "Host": [
        "example.com"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            longitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The longitude of datacenter containing the origins used in this pool in decimal degrees. If this is set latitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              disabled_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              minimum_origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A human-readable description of the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Primary data center - Provider XYZ"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":false,"check_regions":["WEU","ENAM"],"load_shedding":{"default_percent":0,"default_policy":"random","session_percent":0,"session_policy":"hash"},"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56,"header":{"Host":["example.com"]}}],"origin_steering":{"policy":"random"},"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                load-balancer-pools-delete-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete a configured pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE user/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                load-balancer-pools-preview-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Preview Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST user/load_balancers/pools/:identifier/preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/preview" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "pools": {
      "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
      "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    load-balancer-pools-list-pool-references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Pool References 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the list of resources that reference the provided pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET user/load_balancers/pools/:identifier/references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/references" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "resource_id": "699d98642c564d2e855e9661899b7252",
      "resource_name": "www.example.com",
      "resource_type": "load_balancer",
      "reference_type": "referrer"
    },
    {
      "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "resource_name": "Login page monitor",
      "resource_type": "monitor",
      "reference_type": "referral"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Load Balancer Healthcheck Events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    User-level Load Balancing Healthcheck Events Log
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    load-balancer-healthcheck-events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    load-balancer-healthcheck-events-list-healthcheck-events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Healthcheck Events 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List origin health changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET user/load_balancing_analytics/events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Start date and time of requesting data period in the ISO8601 format
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "2016-11-11T12:00:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      until
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      End date and time of requesting data period in the ISO8601 format
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "2016-11-11T13:00:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        origin_name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The name for the origin to filter for.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pool_name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name for the pool to filter for.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "primary-dc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            pool_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            API item identifier tag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "17b5962d775c646f3f9725cbc7a53df4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            origin_healthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If true, filter events where the origin status is healthy, if false, filter events where the origin status is unhealthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            pool_healthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If true, filter events where the pool status is healthy, if false, filter events where the pool status is unhealthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/user/load_balancing_analytics/events?since=2016-11-11T12:00:00Z&until=2016-11-11T13:00:00Z&origin_name=primary-dc-1&pool_name=primary-dc&pool_id=17b5962d775c646f3f9725cbc7a53df4&origin_healthy=true&pool_healthy=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 2,
      "timestamp": "2014-01-01T05:20:00.12345Z",
      "pool": {
        "id": "74bc6a8b9b0dda3d651707a2928bad0c",
        "name": "some-pool",
        "healthy": true,
        "changed": true,
        "minimum_origins": 1
      },
      "origins": [
        {
          "name": "some-origin",
          "address": "198.51.100.4",
          "ip": "198.51.100.4",
          "enabled": true,
          "healthy": true,
          "failure_reason": "No failures",
          "changed": true
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Load Balancer Regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Region-Country geographic mappings for load balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancer-regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancer-regions-list-regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Regions 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List all region mappings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/load_balancers/regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            country_code
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Two-letter alpha-2 country code followed in ISO 3166-1.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "US"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subdivision_code
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Two-letter subdivision code followed in ISO 3166-2.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "CA"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/regions?country_code=US&subdivision_code=CA" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "iso_standard": "Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2",
    "regions": [
      {
        "region_code": "WNAM",
        "countries": [
          {
            "country_code_a2": "US",
            "country_name": "United States",
            "country_subdivisions": [
              {
                "subdivision_code_a2": "CA",
                "subdivision_name": "California"
              }
            ]
          }
        ]
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                load-balancer-regions-get-region
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Get Region 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get a single region mapping
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/load_balancers/regions/:region_code
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/regions/WNAM" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "iso_standard": "Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2",
    "regions": [
      {
        "region_code": "WNAM",
        "countries": [
          {
            "country_code_a2": "CA",
            "country_name": "Canada",
            "country_subdivisions": [
              {
                "subdivision_code_a2": "AB",
                "subdivision_name": "Alberta"
              },
              {
                "subdivision_code_a2": "BC",
                "subdivision_name": "British Columbia"
              }
            ]
          },
          {
            "country_code_a2": "HT",
            "country_name": "Haiti"
          },
          {
            "country_code_a2": "MX",
            "country_name": "Mexico"
          },
          {
            "country_code_a2": "US",
            "country_name": "United States",
            "country_subdivisions": [
              {
                "subdivision_code_a2": "AZ",
                "subdivision_name": "Arizona"
              },
              {
                "subdivision_code_a2": "CA",
                "subdivision_name": "California"
              },
              {
                "subdivision_code_a2": "CO",
                "subdivision_name": "Colorado"
              },
              {
                "subdivision_code_a2": "HI",
                "subdivision_name": "Hawaii"
              },
              {
                "subdivision_code_a2": "MN",
                "subdivision_name": "Minnesota"
              },
              {
                "subdivision_code_a2": "MO",
                "subdivision_name": "Missouri"
              },
              {
                "subdivision_code_a2": "NV",
                "subdivision_name": "Nevada"
              },
              {
                "subdivision_code_a2": "OR",
                "subdivision_name": "Oregon"
              },
              {
                "subdivision_code_a2": "TX",
                "subdivision_name": "Texas"
              },
              {
                "subdivision_code_a2": "UT",
                "subdivision_name": "Utah"
              },
              {
                "subdivision_code_a2": "WA",
                "subdivision_name": "Washington"
              }
            ]
          }
        ]
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Account Load Balancer Monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Account-level Monitor configurations. Monitors define whether we check over HTTP, HTTPS or TCP, the status code(s) we look for, the interval at which we check, timeouts and response body matching.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-monitors-list-monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET List Monitors 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List configured monitors for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/load_balancers/monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "type": "https",
      "description": "Login page monitor",
      "method": "GET",
      "path": "/health",
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      },
      "port": 8080,
      "timeout": 3,
      "retries": 0,
      "interval": 90,
      "expected_body": "alive",
      "expected_codes": "2xx",
      "follow_redirects": true,
      "allow_insecure": true,
      "consecutive_up": 3,
      "consecutive_down": 2,
      "probe_zone": "example.com"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-monitors-create-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a configured monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/load_balancers/monitors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                90
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consecutive_up
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To be marked healthy the monitored origin must pass this healthcheck N consecutive times
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consecutive_down
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Login page monitor"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"consecutive_up":3,"consecutive_down":2,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true,
    "consecutive_up": 3,
    "consecutive_down": 2,
    "probe_zone": "example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        account-load-balancer-monitors-monitor-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Monitor Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List a single configured monitor for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true,
    "consecutive_up": 3,
    "consecutive_down": 2,
    "probe_zone": "example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        account-load-balancer-monitors-update-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Modify a configured monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT accounts/:account_identifier/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        90
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consecutive_up
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To be marked healthy the monitored origin must pass this healthcheck N consecutive times
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consecutive_down
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Login page monitor"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"consecutive_up":3,"consecutive_down":2,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true,
    "consecutive_up": 3,
    "consecutive_down": 2,
    "probe_zone": "example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-monitors-patch-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH Patch Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Apply changes to an existing monitor, overwriting the supplied properties.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH accounts/:account_identifier/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                90
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consecutive_up
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To be marked healthy the monitored origin must pass this healthcheck N consecutive times
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consecutive_down
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Login page monitor"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","description":"Login page monitor","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"interval":90,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"consecutive_up":3,"consecutive_down":2,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "type": "https",
    "description": "Login page monitor",
    "method": "GET",
    "path": "/health",
    "header": {
      "Host": [
        "example.com"
      ],
      "X-App-ID": [
        "abc123"
      ]
    },
    "port": 8080,
    "timeout": 3,
    "retries": 0,
    "interval": 90,
    "expected_body": "alive",
    "expected_codes": "2xx",
    "follow_redirects": true,
    "allow_insecure": true,
    "consecutive_up": 3,
    "consecutive_down": 2,
    "probe_zone": "example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        account-load-balancer-monitors-delete-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE Delete Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete a configured monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE accounts/:account_identifier/load_balancers/monitors/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f1aba936b94213e5b8dca0c0dbf1f9cc"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        account-load-balancer-monitors-preview-monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST Preview Monitor 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST accounts/:account_identifier/load_balancers/monitors/:identifier/preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc/preview" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "pools": {
      "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
      "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              account-load-balancer-monitors-preview-result
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET Preview Result 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the result of a previous preview operation using the provided preview_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/load_balancers/preview/:preview_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/preview/p1aba936b94213e5b8dca0c0dbf1f9cc?" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "abwlnp5jbqn45ecgxd03erbgtxtqai0d": {
    "healthy": true,
    "origins": [
      {
        "originone.example.com.": {
          "healthy": true,
          "rtt": "66ms",
          "failure_reason": "No failures",
          "response_code": 200
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              account-load-balancer-monitors-list-monitor-references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET List Monitor References 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the list of resources that reference the provided monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/load_balancers/monitors/:identifier/references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/monitors/f1aba936b94213e5b8dca0c0dbf1f9cc/references" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
      "resource_name": "primary-dc-1",
      "resource_type": "pool",
      "reference_type": "referrer"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Account Load Balancer Pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Account-level Load Balancer Pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              account-load-balancer-pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              account-load-balancer-pools-list-pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET List Pools 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List configured pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/load_balancers/pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools?monitor=f1aba936b94213e5b8dca0c0dbf1f9cc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "17b5962d775c646f3f9725cbc7a53df4",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "description": "Primary data center - Provider XYZ",
      "name": "primary-dc-1",
      "enabled": false,
      "load_shedding": {
        "default_percent": 0,
        "default_policy": "random",
        "session_percent": 0,
        "session_policy": "hash"
      },
      "minimum_origins": 2,
      "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "check_regions": [
        "WEU",
        "ENAM"
      ],
      "origins": [
        {
          "name": "app-server-1",
          "address": "0.0.0.0",
          "enabled": true,
          "weight": 0.56,
          "header": {
            "Host": [
              "example.com"
            ]
          }
        }
      ],
      "origin_steering": {
        "policy": "random"
      },
      "notification_email": "someone@example.com,sometwo@example.com",
      "notification_filter": {
        "origin": {
          "disable": false,
          "healthy": null
        },
        "pool": {
          "disable": false,
          "healthy": null
        }
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              account-load-balancer-pools-create-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              POST Create Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Create a new pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              POST accounts/:account_identifier/load_balancers/pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "name": "app-server-1",
    "address": "0.0.0.0",
    "enabled": true,
    "weight": 0.56,
    "header": {
      "Host": [
        "example.com"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  notification_email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "someone@example.com,sometwo@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    origin_steering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Configure origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "policy": "random"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      load_shedding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Configure load shedding policies and percentages for the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "default_percent": 0,
  "default_policy": "random",
  "session_percent": 0,
  "session_policy": "hash"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        latitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The latitude of datacenter containing the origins used in this pool in decimal degrees. If this is set longitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification_filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Filter pool and origin health notifications by resource type or health status. Use null to reset.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "origin": {
    "disable": false,
    "healthy": null
  },
  "pool": {
    "disable": false,
    "healthy": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            longitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The longitude of datacenter containing the origins used in this pool in decimal degrees. If this is set latitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              minimum_origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A human-readable description of the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Primary data center - Provider XYZ"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":false,"load_shedding":{"default_percent":0,"default_policy":"random","session_percent":0,"session_policy":"hash"},"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56,"header":{"Host":["example.com"]}}],"origin_steering":{"policy":"random"},"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-pools-pool-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Pool Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fetch a single configured pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-pools-pool-health-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Pool Health Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fetch latest healthcheck details for a single pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/load_balancers/pools/:identifier/health
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/health" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "pool_id": "17b5962d775c646f3f9725cbc7a53df4",
    "pop_health": {
      "Amsterdam, NL": {
        "healthy": true,
        "origins": [
          {
            "2001:DB8::5": {
              "healthy": true,
              "rtt": "12.1ms",
              "failure_reason": "No failures",
              "response_code": 401
            }
          }
        ]
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                account-load-balancer-pools-update-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT Update Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Modify a configured pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "name": "app-server-1",
    "address": "0.0.0.0",
    "enabled": true,
    "weight": 0.56,
    "header": {
      "Host": [
        "example.com"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification_email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "someone@example.com,sometwo@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A list of regions from which to run health checks. Null means every Cloudflare datacenter.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      origin_steering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Configure origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "policy": "random"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        load_shedding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Configure load shedding policies and percentages for the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "default_percent": 0,
  "default_policy": "random",
  "session_percent": 0,
  "session_policy": "hash"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          latitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The latitude of datacenter containing the origins used in this pool in decimal degrees. If this is set longitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            notification_filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Filter pool and origin health notifications by resource type or health status. Use null to reset.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "origin": {
    "disable": false,
    "healthy": null
  },
  "pool": {
    "disable": false,
    "healthy": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              longitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The longitude of datacenter containing the origins used in this pool in decimal degrees. If this is set latitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                disabled_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minimum_origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A human-readable description of the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Primary data center - Provider XYZ"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":false,"check_regions":["WEU","ENAM"],"load_shedding":{"default_percent":0,"default_policy":"random","session_percent":0,"session_policy":"hash"},"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56,"header":{"Host":["example.com"]}}],"origin_steering":{"policy":"random"},"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-load-balancer-pools-patch-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Patch Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Apply changes to an existing pool, overwriting the supplied properties.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH accounts/:account_identifier/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Whether to enable (the default) this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  notification_email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "someone@example.com,sometwo@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A list of regions from which to run health checks. Null means every Cloudflare datacenter.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    origin_steering
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Configure origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "policy": "random"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A short name (tag) for the pool. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "primary-dc-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        load_shedding
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Configure load shedding policies and percentages for the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "default_percent": 0,
  "default_policy": "random",
  "session_percent": 0,
  "session_policy": "hash"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          latitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The latitude of datacenter containing the origins used in this pool in decimal degrees. If this is set longitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            notification_filter
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Filter pool and origin health notifications by resource type or health status. Use null to reset.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "origin": {
    "disable": false,
    "healthy": null
  },
  "pool": {
    "disable": false,
    "healthy": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "name": "app-server-1",
    "address": "0.0.0.0",
    "enabled": true,
    "weight": 0.56,
    "header": {
      "Host": [
        "example.com"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                longitude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The longitude of datacenter containing the origins used in this pool in decimal degrees. If this is set latitude must also be.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disabled_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  monitor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The ID of the Monitor to use for health checking origins within this pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "f1aba936b94213e5b8dca0c0dbf1f9cc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minimum_origins
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we wil failover to the next available pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A human-readable description of the pool.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Primary data center - Provider XYZ"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Primary data center - Provider XYZ","name":"primary-dc-1","enabled":false,"check_regions":["WEU","ENAM"],"load_shedding":{"default_percent":0,"default_policy":"random","session_percent":0,"session_policy":"hash"},"minimum_origins":2,"monitor":"f1aba936b94213e5b8dca0c0dbf1f9cc","origins":[{"name":"app-server-1","address":"0.0.0.0","enabled":true,"weight":0.56,"header":{"Host":["example.com"]}}],"origin_steering":{"policy":"random"},"notification_email":"someone@example.com,sometwo@example.com","notification_filter":{"origin":{"disable":false,"healthy":null},"pool":{"disable":false,"healthy":null}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Primary data center - Provider XYZ",
    "name": "primary-dc-1",
    "enabled": false,
    "load_shedding": {
      "default_percent": 0,
      "default_policy": "random",
      "session_percent": 0,
      "session_policy": "hash"
    },
    "minimum_origins": 2,
    "monitor": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "origins": [
      {
        "name": "app-server-1",
        "address": "0.0.0.0",
        "enabled": true,
        "weight": 0.56,
        "header": {
          "Host": [
            "example.com"
          ]
        }
      }
    ],
    "origin_steering": {
      "policy": "random"
    },
    "notification_email": "someone@example.com,sometwo@example.com",
    "notification_filter": {
      "origin": {
        "disable": false,
        "healthy": null
      },
      "pool": {
        "disable": false,
        "healthy": null
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    account-load-balancer-pools-delete-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete a configured pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:account_identifier/load_balancers/pools/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "17b5962d775c646f3f9725cbc7a53df4"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    account-load-balancer-pools-preview-pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Preview Pool 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:account_identifier/load_balancers/pools/:identifier/preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    expected_codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "2xx"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Port number to connect to for the health check. Required for TCP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    8080
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "GET"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: GET
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The timeout (in seconds) before marking the health check as failed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The endpoint path to health check against. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "/health"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    0
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    follow_redirects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    expected_body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "alive"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      header
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "Host": [
    "example.com"
  ],
  "X-App-ID": [
    "abc123"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allow_insecure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "https"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: http
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        probe_zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Assign this monitor to emulate the specified zone while probing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/preview" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"https","method":"GET","path":"/health","header":{"Host":["example.com"],"X-App-ID":["abc123"]},"port":8080,"timeout":3,"retries":0,"expected_body":"alive","expected_codes":"2xx","follow_redirects":true,"allow_insecure":true,"probe_zone":"example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "preview_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
    "pools": {
      "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter",
      "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          account-load-balancer-pools-list-pool-references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Pool References 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get the list of resources that reference the provided pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:account_identifier/load_balancers/pools/:identifier/references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/pools/17b5962d775c646f3f9725cbc7a53df4/references" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "resource_id": "699d98642c564d2e855e9661899b7252",
      "resource_name": "www.example.com",
      "resource_type": "load_balancer",
      "reference_type": "referrer"
    },
    {
      "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
      "resource_name": "Login page monitor",
      "resource_type": "monitor",
      "reference_type": "referral"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Account Load Balancer Search
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Account-level Load Balancer Search
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          account-load-balancer-search
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          account-load-balancer-search-search-resources
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Search Resources 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search for Load Balancing resources
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:account_identifier/load_balancers/search
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Requested page within paginated list of results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Maximum number of results requested
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          query
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search query term
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "primary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          references
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The type of references to include ("*" for all).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "*"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: , *, referral, referrer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/load_balancers/search?page=undefined&per_page=25&query=primary&references=*" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "resources": [
      {
        "resource_id": "17b5962d775c646f3f9725cbc7a53df4",
        "resource_name": "primary-dc-1",
        "resource_type": "pool",
        "references": [
          {
            "resource_id": "699d98642c564d2e855e9661899b7252",
            "resource_name": "www.example.com",
            "resource_type": "load_balancer",
            "reference_type": "referrer"
          },
          {
            "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc",
            "resource_name": "Login page monitor",
            "resource_type": "monitor",
            "reference_type": "referral"
          }
        ]
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Load Balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Zone-level Load Balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancers-list-load-balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Load Balancers 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List configured load balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:identifier/load_balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "699d98642c564d2e855e9661899b7252",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "description": "Load Balancer for www.example.com",
      "name": "www.example.com",
      "enabled": true,
      "ttl": 30,
      "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
      "default_pools": [
        "17b5962d775c646f3f9725cbc7a53df4",
        "9290f38c5d07c2e2f4df57b1f61d4196",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "region_pools": {
        "WNAM": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "ENAM": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "pop_pools": {
        "LAX": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "LHR": [
          "abd90f38ced07c2e2f4df50b1f61d4194",
          "f9138c5d07c2e2f4df57b1f61d4196"
        ],
        "SJC": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "proxied": true,
      "steering_policy": "dynamic_latency",
      "session_affinity": "cookie",
      "session_affinity_attributes": {
        "samesite": "Auto",
        "secure": "Auto",
        "drain_duration": 100
      },
      "session_affinity_ttl": 5000,
      "rules": [
        {
          "name": "route the path /testing to testing datacenter.",
          "condition": "http.request.uri.path contains \"/testing\"",
          "overrides": {
            "session_affinity": "cookie",
            "session_affinity_ttl": 5000,
            "session_affinity_attributes": {
              "samesite": "Auto",
              "secure": "Auto",
              "drain_duration": 100
            },
            "ttl": 30,
            "steering_policy": "dynamic_latency",
            "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
            "default_pools": [
              "17b5962d775c646f3f9725cbc7a53df4",
              "9290f38c5d07c2e2f4df57b1f61d4196",
              "00920f38ce07c2e2f4df50b1f61d4194"
            ],
            "pop_pools": {
              "LAX": [
                "de90f38ced07c2e2f4df50b1f61d4194",
                "9290f38c5d07c2e2f4df57b1f61d4196"
              ],
              "LHR": [
                "abd90f38ced07c2e2f4df50b1f61d4194",
                "f9138c5d07c2e2f4df57b1f61d4196"
              ],
              "SJC": [
                "00920f38ce07c2e2f4df50b1f61d4194"
              ]
            },
            "region_pools": {
              "WNAM": [
                "de90f38ced07c2e2f4df50b1f61d4194",
                "9290f38c5d07c2e2f4df57b1f61d4196"
              ],
              "ENAM": [
                "00920f38ce07c2e2f4df50b1f61d4194"
              ]
            }
          },
          "priority": 55,
          "disabled": false,
          "terminates": false,
          "fixed_response": {
            "message_body": "Testing Hello",
            "status_code": 200,
            "content_type": "application/json",
            "location": "www.example.com"
          }
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          load-balancers-create-load-balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Load Balancer 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new load balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST zones/:identifier/load_balancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            default_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  "17b5962d775c646f3f9725cbc7a53df4",
  "9290f38c5d07c2e2f4df57b1f61d4196",
  "00920f38ce07c2e2f4df50b1f61d4194"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              fallback_pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The pool ID to use when all other pools are detected as unhealthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "17b5962d775c646f3f9725cbc7a53df4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              steering_policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Steering Policy for this load balancer. "off": use default_pools, "geo": use region_pools/pop_pools, "random": select a pool randomly, "dynamic_latency": use round trip time to select the closest pool in default_pools (requires pool health checks), "proximity": use the pools latitude and longitude to select the closest pool using the cloudflare pop location for proxied requests or geoip / edns0-client-subnet for non-proxied, "": will map to "geo" if you use region_pools/pop_pools otherwise "off"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "dynamic_latency"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: off, geo, random, dynamic_latency, proximity, ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              session_affinity_attributes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Configure cookie attributes for session affinity cookie.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "samesite": "Auto",
  "secure": "Auto",
  "drain_duration": 100
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pop_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using default_pools.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "LAX": [
    "de90f38ced07c2e2f4df50b1f61d4194",
    "9290f38c5d07c2e2f4df57b1f61d4196"
  ],
  "LHR": [
    "abd90f38ced07c2e2f4df50b1f61d4194",
    "f9138c5d07c2e2f4df57b1f61d4196"
  ],
  "SJC": [
    "00920f38ce07c2e2f4df50b1f61d4194"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    region_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A mapping of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "WNAM": [
    "de90f38ced07c2e2f4df50b1f61d4194",
    "9290f38c5d07c2e2f4df57b1f61d4196"
  ],
  "ENAM": [
    "00920f38ce07c2e2f4df50b1f61d4194"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      session_affinity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The session_affinity specifies the type of session affinity the loadbalancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "cookie"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: none, cookie, ip_cookie, ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      BETA Field Not General Access: A list of rules for this load balancer to execute.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "name": "route the path /testing to testing datacenter.",
    "condition": "http.request.uri.path contains \"/testing\"",
    "overrides": {
      "session_affinity": "cookie",
      "session_affinity_ttl": 5000,
      "session_affinity_attributes": {
        "samesite": "Auto",
        "secure": "Auto",
        "drain_duration": 100
      },
      "ttl": 30,
      "steering_policy": "dynamic_latency",
      "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
      "default_pools": [
        "17b5962d775c646f3f9725cbc7a53df4",
        "9290f38c5d07c2e2f4df57b1f61d4196",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "pop_pools": {
        "LAX": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "LHR": [
          "abd90f38ced07c2e2f4df50b1f61d4194",
          "f9138c5d07c2e2f4df57b1f61d4196"
        ],
        "SJC": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "region_pools": {
        "WNAM": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "ENAM": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      }
    },
    "priority": 55,
    "disabled": false,
    "terminates": false,
    "fixed_response": {
      "message_body": "Testing Hello",
      "status_code": 200,
      "content_type": "application/json",
      "location": "www.example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Load Balancer for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          proxied
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Whether the hostname should be gray clouded (false) or orange clouded (true).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          session_affinity_ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Load Balancer for www.example.com","name":"www.example.com","ttl":30,"fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]},"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"proxied":true,"steering_policy":"dynamic_latency","session_affinity":"cookie","session_affinity_attributes":{"samesite":"Auto","secure":"Auto","drain_duration":100},"session_affinity_ttl":5000,"rules":[{"name":"route the path /testing to testing datacenter.","condition":"http.request.uri.path contains \"/testing\"","overrides":{"session_affinity":"cookie","session_affinity_ttl":5000,"session_affinity_attributes":{"samesite":"Auto","secure":"Auto","drain_duration":100},"ttl":30,"steering_policy":"dynamic_latency","fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]}},"priority":55,"disabled":false,"terminates":false,"fixed_response":{"message_body":"Testing Hello","status_code":200,"content_type":"application/json","location":"www.example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Load Balancer for www.example.com",
    "name": "www.example.com",
    "enabled": true,
    "ttl": 30,
    "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "region_pools": {
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "steering_policy": "dynamic_latency",
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "samesite": "Auto",
      "secure": "Auto",
      "drain_duration": 100
    },
    "session_affinity_ttl": 5000,
    "rules": [
      {
        "name": "route the path /testing to testing datacenter.",
        "condition": "http.request.uri.path contains \"/testing\"",
        "overrides": {
          "session_affinity": "cookie",
          "session_affinity_ttl": 5000,
          "session_affinity_attributes": {
            "samesite": "Auto",
            "secure": "Auto",
            "drain_duration": 100
          },
          "ttl": 30,
          "steering_policy": "dynamic_latency",
          "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "region_pools": {
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          }
        },
        "priority": 55,
        "disabled": false,
        "terminates": false,
        "fixed_response": {
          "message_body": "Testing Hello",
          "status_code": 200,
          "content_type": "application/json",
          "location": "www.example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancers-load-balancer-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Load Balancer Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch a single configured load balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:identifier/load_balancers/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Load Balancer for www.example.com",
    "name": "www.example.com",
    "enabled": true,
    "ttl": 30,
    "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "region_pools": {
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "steering_policy": "dynamic_latency",
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "samesite": "Auto",
      "secure": "Auto",
      "drain_duration": 100
    },
    "session_affinity_ttl": 5000,
    "rules": [
      {
        "name": "route the path /testing to testing datacenter.",
        "condition": "http.request.uri.path contains \"/testing\"",
        "overrides": {
          "session_affinity": "cookie",
          "session_affinity_ttl": 5000,
          "session_affinity_attributes": {
            "samesite": "Auto",
            "secure": "Auto",
            "drain_duration": 100
          },
          "ttl": 30,
          "steering_policy": "dynamic_latency",
          "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "region_pools": {
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          }
        },
        "priority": 55,
        "disabled": false,
        "terminates": false,
        "fixed_response": {
          "message_body": "Testing Hello",
          "status_code": 200,
          "content_type": "application/json",
          "location": "www.example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            load-balancers-update-load-balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update Load Balancer 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update a configured load balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT zones/:identifier/load_balancers/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              default_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  "17b5962d775c646f3f9725cbc7a53df4",
  "9290f38c5d07c2e2f4df57b1f61d4196",
  "00920f38ce07c2e2f4df50b1f61d4194"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fallback_pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The pool ID to use when all other pools are detected as unhealthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "17b5962d775c646f3f9725cbc7a53df4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                steering_policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Steering Policy for this load balancer. "off": use default_pools, "geo": use region_pools/pop_pools, "random": select a pool randomly, "dynamic_latency": use round trip time to select the closest pool in default_pools (requires pool health checks), "proximity": use the pools latitude and longitude to select the closest pool using the cloudflare pop location for proxied requests or geoip / edns0-client-subnet for non-proxied, "": will map to "geo" if you use region_pools/pop_pools otherwise "off"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "dynamic_latency"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: off, geo, random, dynamic_latency, proximity, ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Whether to enable (the default) this load balancer.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                session_affinity_attributes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Configure cookie attributes for session affinity cookie.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "samesite": "Auto",
  "secure": "Auto",
  "drain_duration": 100
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pop_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using default_pools.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "LAX": [
    "de90f38ced07c2e2f4df50b1f61d4194",
    "9290f38c5d07c2e2f4df57b1f61d4196"
  ],
  "LHR": [
    "abd90f38ced07c2e2f4df50b1f61d4194",
    "f9138c5d07c2e2f4df57b1f61d4196"
  ],
  "SJC": [
    "00920f38ce07c2e2f4df50b1f61d4194"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      region_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A mapping of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "WNAM": [
    "de90f38ced07c2e2f4df50b1f61d4194",
    "9290f38c5d07c2e2f4df57b1f61d4196"
  ],
  "ENAM": [
    "00920f38ce07c2e2f4df50b1f61d4194"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        session_affinity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The session_affinity specifies the type of session affinity the loadbalancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cookie"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: none, cookie, ip_cookie, ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BETA Field Not General Access: A list of rules for this load balancer to execute.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "name": "route the path /testing to testing datacenter.",
    "condition": "http.request.uri.path contains \"/testing\"",
    "overrides": {
      "session_affinity": "cookie",
      "session_affinity_ttl": 5000,
      "session_affinity_attributes": {
        "samesite": "Auto",
        "secure": "Auto",
        "drain_duration": 100
      },
      "ttl": 30,
      "steering_policy": "dynamic_latency",
      "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
      "default_pools": [
        "17b5962d775c646f3f9725cbc7a53df4",
        "9290f38c5d07c2e2f4df57b1f61d4196",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "pop_pools": {
        "LAX": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "LHR": [
          "abd90f38ced07c2e2f4df50b1f61d4194",
          "f9138c5d07c2e2f4df57b1f61d4196"
        ],
        "SJC": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "region_pools": {
        "WNAM": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "ENAM": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      }
    },
    "priority": 55,
    "disabled": false,
    "terminates": false,
    "fixed_response": {
      "message_body": "Testing Hello",
      "status_code": 200,
      "content_type": "application/json",
      "location": "www.example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Load Balancer for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            proxied
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether the hostname should be gray clouded (false) or orange clouded (true).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            session_affinity_ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            5000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Load Balancer for www.example.com","name":"www.example.com","ttl":30,"fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]},"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"proxied":true,"enabled":true,"steering_policy":"dynamic_latency","session_affinity":"cookie","session_affinity_attributes":{"samesite":"Auto","secure":"Auto","drain_duration":100},"session_affinity_ttl":5000,"rules":[{"name":"route the path /testing to testing datacenter.","condition":"http.request.uri.path contains \"/testing\"","overrides":{"session_affinity":"cookie","session_affinity_ttl":5000,"session_affinity_attributes":{"samesite":"Auto","secure":"Auto","drain_duration":100},"ttl":30,"steering_policy":"dynamic_latency","fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]}},"priority":55,"disabled":false,"terminates":false,"fixed_response":{"message_body":"Testing Hello","status_code":200,"content_type":"application/json","location":"www.example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Load Balancer for www.example.com",
    "name": "www.example.com",
    "enabled": true,
    "ttl": 30,
    "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "region_pools": {
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "steering_policy": "dynamic_latency",
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "samesite": "Auto",
      "secure": "Auto",
      "drain_duration": 100
    },
    "session_affinity_ttl": 5000,
    "rules": [
      {
        "name": "route the path /testing to testing datacenter.",
        "condition": "http.request.uri.path contains \"/testing\"",
        "overrides": {
          "session_affinity": "cookie",
          "session_affinity_ttl": 5000,
          "session_affinity_attributes": {
            "samesite": "Auto",
            "secure": "Auto",
            "drain_duration": 100
          },
          "ttl": 30,
          "steering_policy": "dynamic_latency",
          "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "region_pools": {
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          }
        },
        "priority": 55,
        "disabled": false,
        "terminates": false,
        "fixed_response": {
          "message_body": "Testing Hello",
          "status_code": 200,
          "content_type": "application/json",
          "location": "www.example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              load-balancers-patch-load-balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH Patch Load Balancer 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Apply changes to an existing load balancer, overwriting the supplied properties.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH zones/:identifier/load_balancers/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              steering_policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Steering Policy for this load balancer. "off": use default_pools, "geo": use region_pools/pop_pools, "random": select a pool randomly, "dynamic_latency": use round trip time to select the closest pool in default_pools (requires pool health checks), "proximity": use the pools latitude and longitude to select the closest pool using the cloudflare pop location for proxied requests or geoip / edns0-client-subnet for non-proxied, "": will map to "geo" if you use region_pools/pop_pools otherwise "off"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "dynamic_latency"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: off, geo, random, dynamic_latency, proximity, ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Whether to enable (the default) this load balancer.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              session_affinity_attributes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Configure cookie attributes for session affinity cookie.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "samesite": "Auto",
  "secure": "Auto",
  "drain_duration": 100
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pop_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                (Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using default_pools.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "LAX": [
    "de90f38ced07c2e2f4df50b1f61d4194",
    "9290f38c5d07c2e2f4df57b1f61d4196"
  ],
  "LHR": [
    "abd90f38ced07c2e2f4df50b1f61d4194",
    "f9138c5d07c2e2f4df57b1f61d4196"
  ],
  "SJC": [
    "00920f38ce07c2e2f4df50b1f61d4194"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      region_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A mapping of region/country codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "WNAM": [
    "de90f38ced07c2e2f4df50b1f61d4194",
    "9290f38c5d07c2e2f4df57b1f61d4196"
  ],
  "ENAM": [
    "00920f38ce07c2e2f4df50b1f61d4194"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        session_affinity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The session_affinity specifies the type of session affinity the loadbalancer should use unless specified as "none" or ""(default). The supported types are "cookie" and "ip_cookie". "cookie" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. "ip_cookie" behaves the same as "cookie" except the initial origin selection is stable and based on the client’s ip address.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cookie"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: none, cookie, ip_cookie, ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BETA Field Not General Access: A list of rules for this load balancer to execute.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "name": "route the path /testing to testing datacenter.",
    "condition": "http.request.uri.path contains \"/testing\"",
    "overrides": {
      "session_affinity": "cookie",
      "session_affinity_ttl": 5000,
      "session_affinity_attributes": {
        "samesite": "Auto",
        "secure": "Auto",
        "drain_duration": 100
      },
      "ttl": 30,
      "steering_policy": "dynamic_latency",
      "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
      "default_pools": [
        "17b5962d775c646f3f9725cbc7a53df4",
        "9290f38c5d07c2e2f4df57b1f61d4196",
        "00920f38ce07c2e2f4df50b1f61d4194"
      ],
      "pop_pools": {
        "LAX": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "LHR": [
          "abd90f38ced07c2e2f4df50b1f61d4194",
          "f9138c5d07c2e2f4df57b1f61d4196"
        ],
        "SJC": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      },
      "region_pools": {
        "WNAM": [
          "de90f38ced07c2e2f4df50b1f61d4194",
          "9290f38c5d07c2e2f4df57b1f61d4196"
        ],
        "ENAM": [
          "00920f38ce07c2e2f4df50b1f61d4194"
        ]
      }
    },
    "priority": 55,
    "disabled": false,
    "terminates": false,
    "fixed_response": {
      "message_body": "Testing Hello",
      "status_code": 200,
      "content_type": "application/json",
      "location": "www.example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          default_pools
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  "17b5962d775c646f3f9725cbc7a53df4",
  "9290f38c5d07c2e2f4df57b1f61d4196",
  "00920f38ce07c2e2f4df50b1f61d4194"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            fallback_pool
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The pool ID to use when all other pools are detected as unhealthy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "17b5962d775c646f3f9725cbc7a53df4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Load Balancer for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              proxied
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Whether the hostname should be gray clouded (false) or orange clouded (true).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              session_affinity_ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Time, in seconds, until this load balancers session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              5000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Load Balancer for www.example.com","name":"www.example.com","ttl":30,"fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]},"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"proxied":true,"enabled":true,"steering_policy":"dynamic_latency","session_affinity":"cookie","session_affinity_attributes":{"samesite":"Auto","secure":"Auto","drain_duration":100},"session_affinity_ttl":5000,"rules":[{"name":"route the path /testing to testing datacenter.","condition":"http.request.uri.path contains \"/testing\"","overrides":{"session_affinity":"cookie","session_affinity_ttl":5000,"session_affinity_attributes":{"samesite":"Auto","secure":"Auto","drain_duration":100},"ttl":30,"steering_policy":"dynamic_latency","fallback_pool":"17b5962d775c646f3f9725cbc7a53df4","default_pools":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"pop_pools":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"region_pools":{"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"]}},"priority":55,"disabled":false,"terminates":false,"fixed_response":{"message_body":"Testing Hello","status_code":200,"content_type":"application/json","location":"www.example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "description": "Load Balancer for www.example.com",
    "name": "www.example.com",
    "enabled": true,
    "ttl": 30,
    "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
    "default_pools": [
      "17b5962d775c646f3f9725cbc7a53df4",
      "9290f38c5d07c2e2f4df57b1f61d4196",
      "00920f38ce07c2e2f4df50b1f61d4194"
    ],
    "region_pools": {
      "WNAM": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "ENAM": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "pop_pools": {
      "LAX": [
        "de90f38ced07c2e2f4df50b1f61d4194",
        "9290f38c5d07c2e2f4df57b1f61d4196"
      ],
      "LHR": [
        "abd90f38ced07c2e2f4df50b1f61d4194",
        "f9138c5d07c2e2f4df57b1f61d4196"
      ],
      "SJC": [
        "00920f38ce07c2e2f4df50b1f61d4194"
      ]
    },
    "proxied": true,
    "steering_policy": "dynamic_latency",
    "session_affinity": "cookie",
    "session_affinity_attributes": {
      "samesite": "Auto",
      "secure": "Auto",
      "drain_duration": 100
    },
    "session_affinity_ttl": 5000,
    "rules": [
      {
        "name": "route the path /testing to testing datacenter.",
        "condition": "http.request.uri.path contains \"/testing\"",
        "overrides": {
          "session_affinity": "cookie",
          "session_affinity_ttl": 5000,
          "session_affinity_attributes": {
            "samesite": "Auto",
            "secure": "Auto",
            "drain_duration": 100
          },
          "ttl": 30,
          "steering_policy": "dynamic_latency",
          "fallback_pool": "17b5962d775c646f3f9725cbc7a53df4",
          "default_pools": [
            "17b5962d775c646f3f9725cbc7a53df4",
            "9290f38c5d07c2e2f4df57b1f61d4196",
            "00920f38ce07c2e2f4df50b1f61d4194"
          ],
          "pop_pools": {
            "LAX": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "LHR": [
              "abd90f38ced07c2e2f4df50b1f61d4194",
              "f9138c5d07c2e2f4df57b1f61d4196"
            ],
            "SJC": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          },
          "region_pools": {
            "WNAM": [
              "de90f38ced07c2e2f4df50b1f61d4194",
              "9290f38c5d07c2e2f4df57b1f61d4196"
            ],
            "ENAM": [
              "00920f38ce07c2e2f4df50b1f61d4194"
            ]
          }
        },
        "priority": 55,
        "disabled": false,
        "terminates": false,
        "fixed_response": {
          "message_body": "Testing Hello",
          "status_code": 200,
          "content_type": "application/json",
          "location": "www.example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                load-balancers-delete-load-balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Load Balancer 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete a configured load balancer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE zones/:identifier/load_balancers/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/load_balancers/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                IP Address Management Prefixes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Describe and modify the account's IP prefixes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefixes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefixes-list-prefixes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET List Prefixes 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List all prefixes owned by the account.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/addressing/prefixes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "9a7806061c88ada191ed06f989cc3dac",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "modified_at": "2014-01-01T05:20:00.12345Z",
      "cidr": "192.0.2.0/24",
      "account_id": "01a7362d577a6c3019a474fd6f485823",
      "description": "Internal test prefix",
      "approved": "P",
      "loa_document_id": "d933b1530bc56c9953cf8ce166da8004",
      "on_demand_enabled": true,
      "on_demand_locked": false,
      "advertised": true,
      "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefixes-prefix-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Prefix Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List a particular prefix owned by the account.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/addressing/prefixes/:prefix_identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "cidr": "192.0.2.0/24",
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "description": "Internal test prefix",
    "approved": "P",
    "loa_document_id": "d933b1530bc56c9953cf8ce166da8004",
    "on_demand_enabled": true,
    "on_demand_locked": false,
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefixes-update-prefix-description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH Update Prefix Description 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Modify the description for a prefix owned by the account.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH accounts/:account_identifier/addressing/prefixes/:prefix_identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Description of the prefix
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Internal test prefix"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"description":"Internal test prefix"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "9a7806061c88ada191ed06f989cc3dac",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "cidr": "192.0.2.0/24",
    "account_id": "01a7362d577a6c3019a474fd6f485823",
    "description": "Internal test prefix",
    "approved": "P",
    "loa_document_id": "d933b1530bc56c9953cf8ce166da8004",
    "on_demand_enabled": true,
    "on_demand_locked": false,
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                IP Address Management Dynamic Advertisement
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Manage the desired advertisement state of your account's IP prefixes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-dynamic-advertisement
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-dynamic-advertisement-get-advertisement-status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Get Advertisement Status 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List the current advertisement state for a prefix.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/addressing/prefixes/:prefix_identifier/bgp/status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/bgp/status" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH Update Prefix Dynamic Advertisement Status 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Advertise or withdraw BGP route for a prefix.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH accounts/:account_identifier/addressing/prefixes/:prefix_identifier/bgp/status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                advertised
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enablement of prefix advertisement to the Internet.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/bgp/status" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"advertised":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "advertised": true,
    "advertised_modified_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                IP Address Management Prefix Delegation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Describe and modify delegations for the account's IP prefixes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefix-delegation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefix-delegation-list-prefix-delegations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET List Prefix Delegations 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List all delegations for a given account IP prefix.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:account_identifier/addressing/prefixes/:prefix_identifier/delegations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/delegations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "d933b1530bc56c9953cf8ce166da8004",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "modified_at": "2014-01-01T05:20:00.12345Z",
      "cidr": "192.0.2.0/24",
      "delegated_account_id": "b1946ac92492d2347c6235b4d2611184",
      "parent_prefix_id": "9a7806061c88ada191ed06f989cc3dac"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ip-address-management-prefix-delegation-create-prefix-delegation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create Prefix Delegation 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a new account delegation for a given IP prefix.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/addressing/prefixes/:prefix_identifier/delegations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cidr
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                IP Prefix in Classless Inter-Domain Routing format
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "192.0.2.0/24"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  delegated_account_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Account identifier for the account to which prefix is being delegated
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "b1946ac92492d2347c6235b4d2611184"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/delegations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"cidr":"192.0.2.0/24","delegated_account_id":"b1946ac92492d2347c6235b4d2611184"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "d933b1530bc56c9953cf8ce166da8004",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "modified_at": "2014-01-01T05:20:00.12345Z",
    "cidr": "192.0.2.0/24",
    "delegated_account_id": "b1946ac92492d2347c6235b4d2611184",
    "parent_prefix_id": "9a7806061c88ada191ed06f989cc3dac"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ip-address-management-prefix-delegation-delete-prefix-delegation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete Prefix Delegation 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete an account delegation for a given IP prefix.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE accounts/:account_identifier/addressing/prefixes/:prefix_identifier/delegations/:delegation_identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/addressing/prefixes/9a7806061c88ada191ed06f989cc3dac/delegations/d933b1530bc56c9953cf8ce166da8004" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "d933b1530bc56c9953cf8ce166da8004"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cloudflare Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-list-railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Railguns 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List, search, sort and filter your Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of items per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Direction to order Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/railguns?page=1&per_page=20&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "e928d310693a83094309acf9ead50448",
      "name": "My Railgun",
      "status": "active",
      "enabled": true,
      "zones_connected": 2,
      "build": "b1234",
      "version": "2.1",
      "revision": "123",
      "activation_key": "e4edc00281cb56ebac22c81be9bac8f3",
      "activated_on": "2014-01-02T02:20:00Z",
      "created_on": "2014-01-01T05:20:00Z",
      "modified_on": "2014-01-01T05:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-create-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Readable identifier of the railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "My Railgun"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 160
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/railguns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"My Railgun"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-railgun-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Railgun Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-enable-or-disable-a-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Enable or Disable a Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Enable or disable a Railgun for all zones connected to it
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Flag to determine if the Railgun is accepting connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"enabled":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-delete-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "e928d310693a83094309acf9ead50448"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-list-railgun-zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Railgun Zones 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The zones that are currently using this Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET railguns/:identifier/zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/railguns/e928d310693a83094309acf9ead50448/zones" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com",
      "development_mode": 7200,
      "original_name_servers": [
        "ns1.originaldnshost.com",
        "ns2.originaldnshost.com"
      ],
      "original_registrar": "GoDaddy",
      "original_dnshost": "NameCheap",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "activated_on": "2014-01-02T00:01:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Railgun Connections for a Zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Railguns associated with a zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-connections-for-a-zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-connections-for-a-zone-list-available-railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Available Railguns permission needed: #zone_settings:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A list of available Railguns the zone can use
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "e928d310693a83094309acf9ead50448",
      "name": "My Railgun",
      "enabled": true,
      "connected": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-connections-for-a-zone-railgun-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Railgun Details permission needed: #zone_settings:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Details about a specific Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "e928d310693a83094309acf9ead50448",
    "name": "My Railgun",
    "enabled": true,
    "connected": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-connections-for-a-zone-connect-or-disconnect-a-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Connect or Disconnect a Railgun permission needed: #zone_settings:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Connect or disconnect a Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH zones/:zone_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  connected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A flag indicating whether the given zone is connected to the Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"connected":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "e928d310693a83094309acf9ead50448",
    "name": "My Railgun",
    "enabled": true,
    "connected": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  railgun-connections-for-a-zone-test-railgun-connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Test Railgun Connection permission needed: #zone_settings:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Test Railgun connection to the Zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:zone_identifier/railguns/:identifier/diagnose
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/railguns/e928d310693a83094309acf9ead50448/diagnose" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "method": "GET",
    "host_name": "www.example.com",
    "http_status": 200,
    "railgun": "on",
    "url": "https://www.cloudflare.com",
    "response_status": "200 OK",
    "protocol": "HTTP/1.1",
    "elapsed_time": "0.239013s",
    "body_size": "63910 bytes",
    "body_hash": "be27f2429421e12f200cab1da43ba301bdc70e1d",
    "missing_headers": "No Content-Length or Transfer-Encoding",
    "connection_close": false,
    "cloudflare": "on",
    "cf-ray": "1ddd7570575207d9-LAX",
    "cf-wan-error": null,
    "cf-cache-status": null
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Account Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Cloudflare Railguns available to Accounts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-railguns-list-railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Railguns permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List, search, sort and filter your Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Number of items per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Direction to order Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns?page=1&per_page=20&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "e928d310693a83094309acf9ead50448",
      "name": "My Railgun",
      "status": "active",
      "enabled": true,
      "zones_connected": 2,
      "created_on": "2014-01-01T05:20:00Z",
      "modified_on": "2014-01-01T05:20:00Z",
      "activation": {
        "key": "e4edc00281cb56ebac22c81be9bac8f3",
        "activated_on": "2014-01-02T02:20:00Z",
        "version": {
          "number": "2.1",
          "build": "b1234",
          "revision": "123"
        }
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-railguns-create-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST accounts/:account_identifier/railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Readable identifier of the railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "My Railgun"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 160
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"My Railgun"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-railguns-railgun-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Railgun Details permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  account-railguns-update-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT Update Railgun permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update a Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:account_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Flag to determine if the Railgun is accepting connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Readable identifier of the railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "My Railgun"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 160
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zones_connected
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The number of zones using this railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Status of the railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "active"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: initializing, active
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  activation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "key": "e4edc00281cb56ebac22c81be9bac8f3",
  "activated_on": "2014-01-02T02:20:00Z",
  "version": {
    "number": "2.1",
    "build": "b1234",
    "revision": "123"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Railgun identifier tag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "e928d310693a83094309acf9ead50448"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  upgrade_info
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Defined when the Railgun version is out of date from the latest release from Cloudflare
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "latest_version": "1.0.0",
  "download_link": "https://www.cloudflare.com/downloads/railgun"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    modified_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When the Railgun was last modified
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "2014-01-01T05:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    created_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    When the Railgun was created
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "2014-01-01T05:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"e928d310693a83094309acf9ead50448","name":"My Railgun","status":"active","enabled":true,"zones_connected":2,"created_on":"2014-01-01T05:20:00Z","modified_on":"2014-01-01T05:20:00Z","activation":{"key":"e4edc00281cb56ebac22c81be9bac8f3","activated_on":"2014-01-02T02:20:00Z","version":{"number":"2.1","build":"b1234","revision":"123"}}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    account-railguns-delete-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Railgun permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:account_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "e928d310693a83094309acf9ead50448"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Railgun Connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A Railgun connection associates a zone with the Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    railgun-connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    railgun-connections-list-connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Connections permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List connections associated with the Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:account_identifier/railguns/:railgun_identifier/connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Requested page within paginated list of results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maximum number of results requested
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A value indicating whether the connection is enabled or not
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections?page=1&per_page=20&enabled=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "zone": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "example.com"
      },
      "enabled": true,
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        railgun-connections-connection-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Connection Details permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Get a connection by ID
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/railguns/:railgun_identifier/connections/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections/c4a7362d577a6c3019a474fd6f485821" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "c4a7362d577a6c3019a474fd6f485821",
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "enabled": true,
    "created_on": "2017-06-14T00:00:00Z",
    "modified_on": "2017-06-14T05:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        railgun-connections-update-connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Connection permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Enable or disable a connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT accounts/:account_identifier/railguns/:railgun_identifier/connections/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Connection identifier tag
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "c4a7362d577a6c3019a474fd6f485821"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max length: 32
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "id": "023e105f4ecef8ad9ca31a8372d0c353",
  "name": "example.com"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A value indicating whether the connection is enabled or not
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          created_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When the connection was created
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "2017-06-14T00:00:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          modified_on
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          When the connection was last modified
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "2017-06-14T05:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections/c4a7362d577a6c3019a474fd6f485821" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":"c4a7362d577a6c3019a474fd6f485821","zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353","name":"example.com"},"enabled":true,"created_on":"2017-06-14T00:00:00Z","modified_on":"2017-06-14T05:20:00Z"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "c4a7362d577a6c3019a474fd6f485821",
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "enabled": true,
    "created_on": "2017-06-14T00:00:00Z",
    "modified_on": "2017-06-14T05:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          railgun-connections-delete-connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE Delete Connection permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Disable and remove the connection to a zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE accounts/:account_identifier/railguns/:railgun_identifier/connections/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections/c4a7362d577a6c3019a474fd6f485821" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "c4a7362d577a6c3019a474fd6f485821"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          railgun-connections-create-connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Connection permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Associates a zone to the Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST accounts/:account_identifier/railguns/:railgun_identifier/connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "id": "023e105f4ecef8ad9ca31a8372d0c353"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A value indicating whether the connection is enabled or not
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/connections" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"zone":{"id":"023e105f4ecef8ad9ca31a8372d0c353"},"enabled":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "c4a7362d577a6c3019a474fd6f485821",
    "zone": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com"
    },
    "enabled": true,
    "created_on": "2017-06-14T00:00:00Z",
    "modified_on": "2017-06-14T05:20:00Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Railgun Connections error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Organization Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Cloudflare Railgun for Organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Please use equivalent /accounts API endpoints. Account APIs provide a broader range of features and are backwards-compatible to organization APIs.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            End of life Date: February 4, 2020
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun-list-railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Railguns 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List, search, sort and filter your Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET organizations/:organization_identifier/railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Number of items per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Direction to order Railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: asc, desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns?page=1&per_page=20&direction=desc" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "e928d310693a83094309acf9ead50448",
      "name": "My Railgun",
      "status": "active",
      "enabled": true,
      "zones_connected": 2,
      "build": "b1234",
      "version": "2.1",
      "revision": "123",
      "activation_key": "e4edc00281cb56ebac22c81be9bac8f3",
      "activated_on": "2014-01-02T02:20:00Z",
      "created_on": "2014-01-01T05:20:00Z",
      "modified_on": "2014-01-01T05:20:00Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            End of life Date: February 4, 2020
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun-create-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST organizations/:organization_identifier/railguns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Readable identifier of the railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "My Railgun"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 160
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"My Railgun"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            End of life Date: February 4, 2020
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun-railgun-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Railgun Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET organizations/:organization_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            End of life Date: February 4, 2020
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun-enable-or-disable-a-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PATCH Enable or Disable a Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enable or disable a Railgun for all zones connected to it
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PATCH organizations/:organization_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Flag to determine if the Railgun is accepting connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PATCH "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"enabled":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            End of life Date: February 4, 2020
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun-delete-railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Railgun 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE organizations/:organization_identifier/railguns/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "e928d310693a83094309acf9ead50448"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Deprecation Warning
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            End of life Date: February 4, 2020
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            organization-railgun-get-railgun-zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Get Railgun Zones 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The zones that are currently using this Railgun
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET organizations/:organization_identifier/railguns/:identifier/zones
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/organizations/01a7362d577a6c3019a474fd6f485823/railguns/e928d310693a83094309acf9ead50448/zones" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "example.com",
      "development_mode": 7200,
      "original_name_servers": [
        "ns1.originaldnshost.com",
        "ns2.originaldnshost.com"
      ],
      "original_registrar": "GoDaddy",
      "original_dnshost": "NameCheap",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "activated_on": "2014-01-02T00:01:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Custom Pages (Account)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Custom pages at the account level
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom-pages-account-
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definitions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom-pages-account--list-custom-pages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Custom Pages permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A list of available account-level Custom Pages 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/custom_pages
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/custom_pages" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "basic_challenge",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "url": "http://www.example.com",
      "state": "default",
      "required_tokens": [
        "::CAPTCHA_BOX::"
      ],
      "preview_target": "preview:target",
      "description": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom-pages-account--custom-page-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Custom Page Details permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Details about a specific Custom page details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/custom_pages/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/custom_pages/basic_challenge" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "url": "http://www.example.com",
    "state": "default",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "preview_target": "preview:target",
    "description": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom-pages-account--update-custom-page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update Custom Page permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update custom page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT accounts/:account_identifier/custom_pages/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string (url)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A URL that is associated with the Custom Page.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "http://www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            state
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Custom Page state
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "default"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: default, customized
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/custom_pages/basic_challenge" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"url":"http://www.example.com","state":"default"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "url": "http://www.example.com",
    "state": "default",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "preview_target": "preview:target",
    "description": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Custom Pages (Account) error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1000Invalid user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1001Invalid request. Could not connect to database
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1002Validator dispatcher expects an array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1006Cannot find a valid customization page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1007Invalid validation method being called
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1200A URL is required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1201The URL provided seems to be irregular
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1202Unable to grab the content for the URL provided. Please try again.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1203Your custom page must be larger than <characters> characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1204Your custom page must be smaller than <characters> characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1205A <token> token was not detected on the error page, and must be added before this page can be integrated into Cloudflare. The default error page will show until this is corrected and rescanned.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1206Could not find a valid zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1207That customization page is not modifiable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1208An unknown error has occurred and has been logged. We will fix this problem promptly. We apologize for the inconvenience.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1209Could not find a valid customization page for this operation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1210That operation is no longer allowed for that domain.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1211Could not find a valid customization page to disable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1212An undocumented error has occurred and has been logged.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1213That operation has already been performed for this challenge/error.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1214Rate limit reached for this operation.  Please try again in a minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1215Rate limit reached for this operation.  Please try again in a minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1217Invalid state passed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1218Missing Custom Page state
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1219Please upgrade to access this feature
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1220We were unable to scan the page provided. Please ensure it is accessible publicly and is larger than 100 characters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Access Organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Access Organizations control the look and feel of your login page and the authentication domain it is located at.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            access-organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            access-organizations-access-organization-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Access Organization Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch your Access Organization details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:identifier/access/organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Widget Corps Internal Applications",
    "auth_domain": "test.cloudflareaccess.com",
    "login_design": {
      "background_color": "#c5ed1b",
      "text_color": "#c5ed1b",
      "logo_path": "https://example.com/logo.png"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            access-organizations-create-access-organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Access Organization 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a new Access Organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST accounts/:identifier/access/organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of your Access Organization.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Widget Corps Internal Applications"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auth_domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The domain that you will be redirected to on Access login attempts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "test.cloudflareaccess.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                login_design
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "background_color": "#c5ed1b",
  "text_color": "#c5ed1b",
  "logo_path": "https://example.com/logo.png"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps Internal Applications","auth_domain":"test.cloudflareaccess.com","login_design":{"background_color":"#c5ed1b","text_color":"#c5ed1b","logo_path":"https://example.com/logo.png"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Widget Corps Internal Applications",
    "auth_domain": "test.cloudflareaccess.com",
    "login_design": {
      "background_color": "#c5ed1b",
      "text_color": "#c5ed1b",
      "logo_path": "https://example.com/logo.png"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  access-organizations-update-access-organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT Update Access Organization 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update a configured Access Organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:identifier/access/organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of your Access Organization.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Widget Corps Internal Applications"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    auth_domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The domain that you will be redirected to on Access login attempts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "test.cloudflareaccess.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      login_design
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "background_color": "#c5ed1b",
  "text_color": "#c5ed1b",
  "logo_path": "https://example.com/logo.png"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps Internal Applications","auth_domain":"test.cloudflareaccess.com","login_design":{"background_color":"#c5ed1b","text_color":"#c5ed1b","logo_path":"https://example.com/logo.png"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Widget Corps Internal Applications",
    "auth_domain": "test.cloudflareaccess.com",
    "login_design": {
      "background_color": "#c5ed1b",
      "text_color": "#c5ed1b",
      "logo_path": "https://example.com/logo.png"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        access-organizations-revoke-all-access-tokens-for-a-user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST Revoke all Access Tokens for a user 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Revoke any outstanding tokens issued for a specific user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST accounts/:identifier/access/organizations/revoke_user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The email of the user to revoke
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "test@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/organizations/revoke_user" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"email":"test@example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "result": true
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access Identity Providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access identity providers are the services your user’s will login against to authenticate with your site
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-identity-providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-identity-providers-list-access-identity-providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Access Identity Providers 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List your Access Identity Providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/access/identity_providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "Widget Corps OTP",
      "type": "onetimepin",
      "config": {}
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-identity-providers-access-identity-providers-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Access Identity Providers Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetch your Access Identity Providers details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/access/identity_providers/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-identity-providers-create-access-identity-provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Access Identity Provider 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new Access Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST accounts/:identifier/access/identity_providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name of your Access Identity Provider.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Widget Corps OTP"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The type of Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "onetimepin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The configuration parameters for your identity provider. Please go to https://developers.cloudflare.com/access/configuring-identity-providers/ for more detailed examples.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps OTP","type":"onetimepin","config":{}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-identity-providers-update-access-identity-provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT Update Access Identity Provider 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update a configured Access Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:identifier/access/identity_providers/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The name of your Access Identity Provider.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Widget Corps OTP"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "onetimepin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The configuration parameters for your identity provider. Please go to https://developers.cloudflare.com/access/configuring-identity-providers/ for more detailed examples.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps OTP","type":"onetimepin","config":{}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-identity-providers-delete-access-identity-provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete Access Identity Provider 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete an Access Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE accounts/:identifier/access/identity_providers/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Access Groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Access Groups allow you to define a set of users to which an application policy can be applied. You can reuse Access groups to quickly create policies that apply to the same set of users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-groups-list-access-groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Access Groups 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List Access Groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/access/groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "name": "Allow devs",
      "include": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "exclude": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "require": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-groups-access-group-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Access Group Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Fetch a single Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/access/groups/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-groups-create-access-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create Access Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a new Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST accounts/:identifier/access/groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the group. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              access-groups-update-access-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT Update Access Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Update a configured Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT accounts/:identifier/access/groups/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the group. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-groups-delete-access-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete Access Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete an Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE accounts/:identifier/access/groups/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Access Service Tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Access Service Tokens allow automated requests to reach protected domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-service-tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-service-tokens-list-access-service-tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Access Service Tokens 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List Access Service Tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/access/service_tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "CI/CD token",
      "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      access-service-tokens-create-access-service-token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create Access Service Token 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a new Access Service Token. Note: This is the only time you can get the client secret. Please save it somewhere secure.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST accounts/:identifier/access/service_tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of your Access Service Token.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "CI/CD token"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"CI/CD token"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "CI/CD token",
    "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com",
    "client_secret": "bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        access-service-tokens-update-access-service-token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Access Service Token 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update a configured Access Service Token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT accounts/:identifier/access/service_tokens/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The name of your Access Service Token.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "CI/CD token"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"CI/CD token"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "CI/CD token",
    "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-service-tokens-delete-access-service-token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE Delete Access Service Token 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Delete an Access Service Token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE accounts/:identifier/access/service_tokens/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/service_tokens/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "CI/CD token",
    "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access Short-Lived Certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Short-lived certificates improve access security to infrastructure with ephemeral certificates. Serves as a replacement to traditional SSH key models.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-short-lived-certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-short-lived-certificates-list-short-lived-certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Short-Lived Certificates 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List Short-Lived Certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/access/apps/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/apps/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9",
      "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
      "public_key": "ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-short-lived-certificates-short-lived-certificate-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Short-Lived Certificate Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetch a single short-lived certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/access/apps/:uuid/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-short-lived-certificates-create-short-lived-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Short-Lived Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new short-lived certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST accounts/:identifier/access/apps/:uuid/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-short-lived-certificates-delete-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE Delete Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Delete an Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE accounts/:identifier/access/apps/:uuid/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access Mutual TLS Authentication
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Mutual TLS authentication ensures that the traffic is secure and trusted in both directions between a client and server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-mutual-tls-authentication
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-mutual-tls-authentication-list-access-certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Access Certificates 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List Access Certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/access/certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "expires_on": "2014-01-01T05:20:00.12345Z",
      "name": "Allow devs",
      "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
      "associated_hostnames": [
        "admin.example.com"
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-mutual-tls-authentication-access-certificate-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Access Certificate Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetch a single Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/access/certificates/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
    "associated_hostnames": [
      "admin.example.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access-mutual-tls-authentication-create-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST accounts/:identifier/access/certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name of the Certificate. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Root CA for your certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              associated_hostnames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The hostnames that will be prompted for this certificate.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  "admin.example.com"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","certificate":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","associated_hostnames":["admin.example.com"]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
    "associated_hostnames": [
      "admin.example.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-mutual-tls-authentication-update-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT Update Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update a configured Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:identifier/access/certificates/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The name of the Certificate. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  associated_hostnames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The hostnames that will be prompted for this certificate.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  "admin.example.com"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","associated_hostnames":["admin.example.com"]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
    "associated_hostnames": [
      "admin.example.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-mutual-tls-authentication-delete-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete an Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:identifier/access/certificates/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Access Applications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Access Applications define the routes that Access will block.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications-list-access-applications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Access Applications 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List Access Applications for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/access/apps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
      "name": "Admin Site",
      "domain": "test.example.com/admin",
      "type": "self_hosted",
      "session_duration": "24h",
      "allowed_idps": [
        "699d98642c564d2e855e9661899b7252"
      ],
      "auto_redirect_to_identity": false,
      "enable_binding_cookie": false,
      "http_only_cookie_attribute": true,
      "same_site_cookie_attribute": "strict",
      "cors_headers": {
        "allowed_methods": [
          "GET"
        ],
        "allowed_origins": [
          "https://example.com"
        ],
        "allow_all_headers": true,
        "max_age": -1
      },
      "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
      "skip_interstitial": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications-access-applications-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET Access Applications Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Fetch a single Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/access/apps/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
    "name": "Admin Site",
    "domain": "test.example.com/admin",
    "type": "self_hosted",
    "session_duration": "24h",
    "allowed_idps": [
      "699d98642c564d2e855e9661899b7252"
    ],
    "auto_redirect_to_identity": false,
    "enable_binding_cookie": false,
    "http_only_cookie_attribute": true,
    "same_site_cookie_attribute": "strict",
    "cors_headers": {
      "allowed_methods": [
        "GET"
      ],
      "allowed_origins": [
        "https://example.com"
      ],
      "allow_all_headers": true,
      "max_age": -1
    },
    "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
    "skip_interstitial": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications-create-access-application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create Access Application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a new Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:identifier/access/apps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The domain and path that Access will block
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "test.example.com/admin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the Application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Admin Site"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        same_site_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defines the same-site cookie setting for access tokens. Increases security against CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "strict"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          custom_deny_message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Option that returns a custom error message when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom_deny_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Option that redirects to a custom URL when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              skip_interstitial
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines whether or not access to skip the authorization interstitial when using the cli.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auto_redirect_to_identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Option to skip identity provider selection if only one is configured in allowed_idps.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cors_headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "allowed_methods": [
    "GET"
  ],
  "allowed_origins": [
    "https://example.com"
  ],
  "allow_all_headers": true,
  "max_age": -1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowed_idps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The identity providers selected for application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  "699d98642c564d2e855e9661899b7252"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The application type.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "self_hosted"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: self_hosted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: self_hosted, saas, ssh, vnc, file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enable_binding_cookie
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Option that provides increased security against compromised authorization tokens and CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logo_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Defines the image URL for the logo shown in the app launcher dashboard.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Defines the amount of time that the tokens issued for this application will be valid. Must be in the format '300ms' or '2h45m'. Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "24h"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 24h
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    http_only_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Defines whether or not access tokens will be set as http_only cookies. Increases security against XSS attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Admin Site","domain":"test.example.com/admin","type":"self_hosted","session_duration":"24h","allowed_idps":["699d98642c564d2e855e9661899b7252"],"auto_redirect_to_identity":false,"enable_binding_cookie":false,"http_only_cookie_attribute":true,"same_site_cookie_attribute":"strict","cors_headers":{"allowed_methods":["GET"],"allowed_origins":["https://example.com"],"allow_all_headers":true,"max_age":-1},"logo_url":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","skip_interstitial":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
    "name": "Admin Site",
    "domain": "test.example.com/admin",
    "type": "self_hosted",
    "session_duration": "24h",
    "allowed_idps": [
      "699d98642c564d2e855e9661899b7252"
    ],
    "auto_redirect_to_identity": false,
    "enable_binding_cookie": false,
    "http_only_cookie_attribute": true,
    "same_site_cookie_attribute": "strict",
    "cors_headers": {
      "allowed_methods": [
        "GET"
      ],
      "allowed_origins": [
        "https://example.com"
      ],
      "allow_all_headers": true,
      "max_age": -1
    },
    "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
    "skip_interstitial": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications-update-access-application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update Access Application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update a configured Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT accounts/:identifier/access/apps/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The domain and path that Access will block
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "test.example.com/admin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the Application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Admin Site"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        same_site_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defines the same-site cookie setting for access tokens. Increases security against CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "strict"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          custom_deny_message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Option that returns a custom error message when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom_deny_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Option that redirects to a custom URL when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              skip_interstitial
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines whether or not access to skip the authorization interstitial when using the cli.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auto_redirect_to_identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Option to skip identity provider selection if only one is configured in allowed_idps.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cors_headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "allowed_methods": [
    "GET"
  ],
  "allowed_origins": [
    "https://example.com"
  ],
  "allow_all_headers": true,
  "max_age": -1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowed_idps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The identity providers selected for application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  "699d98642c564d2e855e9661899b7252"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enable_binding_cookie
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Option that provides increased security against compromised authorization tokens and CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logo_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Defines the image URL for the logo shown in the app launcher dashboard.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Defines the amount of time that the tokens issued for this application will be valid. Must be in the format '300ms' or '2h45m'. Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "24h"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 24h
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    http_only_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Defines whether or not access tokens will be set as http_only cookies. Increases security against XSS attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Admin Site","domain":"test.example.com/admin","session_duration":"24h","allowed_idps":["699d98642c564d2e855e9661899b7252"],"auto_redirect_to_identity":false,"enable_binding_cookie":false,"http_only_cookie_attribute":true,"same_site_cookie_attribute":"strict","cors_headers":{"allowed_methods":["GET"],"allowed_origins":["https://example.com"],"allow_all_headers":true,"max_age":-1},"logo_url":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","skip_interstitial":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
    "name": "Admin Site",
    "domain": "test.example.com/admin",
    "type": "self_hosted",
    "session_duration": "24h",
    "allowed_idps": [
      "699d98642c564d2e855e9661899b7252"
    ],
    "auto_redirect_to_identity": false,
    "enable_binding_cookie": false,
    "http_only_cookie_attribute": true,
    "same_site_cookie_attribute": "strict",
    "cors_headers": {
      "allowed_methods": [
        "GET"
      ],
      "allowed_origins": [
        "https://example.com"
      ],
      "allow_all_headers": true,
      "max_age": -1
    },
    "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
    "skip_interstitial": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications-delete-access-application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Access Application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete an Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:identifier/access/apps/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-applications-revoke-access-tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Revoke Access Tokens 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Revoke any outstanding tokens issued for the Application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:identifier/access/apps/:uuid/revoke_tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/revoke_tokens" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Access Policies define the users or groups who can, or cannot, reach the Application Resource.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-policy-list-access-policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Access Policies 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List Access Policies for an Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/access/apps/:uuid/policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "precedence": 1,
      "decision": "allow",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "name": "Allow devs",
      "include": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "exclude": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "require": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "purpose_justification_required": true,
      "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
      "approval_required": true,
      "approval_groups": [
        {
          "email_addresses": [
            "test1@cloudflare.com",
            "test2@cloudflare.com"
          ],
          "approvals_needed": 1
        },
        {
          "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
          "approvals_needed": 3
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-policy-access-policy-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET Access Policy Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Fetch a single Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/access/apps/:uuid/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "precedence": 1,
    "decision": "allow",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "purpose_justification_required": true,
    "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
    "approval_required": true,
    "approval_groups": [
      {
        "email_addresses": [
          "test1@cloudflare.com",
          "test2@cloudflare.com"
        ],
        "approvals_needed": 1
      },
      {
        "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
        "approvals_needed": 3
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    access-policy-create-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create Access Policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a new Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:identifier/access/apps/:uuid/policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the policy. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decision
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defines the action Access will take if the policy matches the user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "allow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: allow, deny, non_identity, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          precedence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The unique precedence for policies on a single application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            purpose_justification_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines whether or not the user is prompted for a justification when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            approval_groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The list of approval groups that must approve the access request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  {
    "email_addresses": [
      "test1@cloudflare.com",
      "test2@cloudflare.com"
    ],
    "approvals_needed": 1
  },
  {
    "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
    "approvals_needed": 3
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              purpose_justification_prompt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The text the user will be prompted with when a purpose justification is required.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Please enter a justification for entering this protected domain"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  approval_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Defines whether or not the user needs to request approval when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"precedence":1,"decision":"allow","name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}],"purpose_justification_required":true,"purpose_justification_prompt":"Please enter a justification for entering this protected domain","approval_required":true,"approval_groups":[{"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"],"approvals_needed":1},{"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34","approvals_needed":3}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "precedence": 1,
    "decision": "allow",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "purpose_justification_required": true,
    "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
    "approval_required": true,
    "approval_groups": [
      {
        "email_addresses": [
          "test1@cloudflare.com",
          "test2@cloudflare.com"
        ],
        "approvals_needed": 1
      },
      {
        "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
        "approvals_needed": 3
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  access-policy-update-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT Update Access Policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update a configured Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:identifier/access/apps/:uuid/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the policy. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      decision
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Defines the action Access will take if the policy matches the user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "allow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: allow, deny, non_identity, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        precedence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The unique precedence for policies on a single application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          purpose_justification_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Defines whether or not the user is prompted for a justification when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          approval_groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The list of approval groups that must approve the access request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "email_addresses": [
      "test1@cloudflare.com",
      "test2@cloudflare.com"
    ],
    "approvals_needed": 1
  },
  {
    "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
    "approvals_needed": 3
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            purpose_justification_prompt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The text the user will be prompted with when a purpose justification is required.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Please enter a justification for entering this protected domain"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                approval_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Defines whether or not the user needs to request approval when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"precedence":1,"decision":"allow","name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}],"purpose_justification_required":true,"purpose_justification_prompt":"Please enter a justification for entering this protected domain","approval_required":true,"approval_groups":[{"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"],"approvals_needed":1},{"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34","approvals_needed":3}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "precedence": 1,
    "decision": "allow",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "purpose_justification_required": true,
    "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
    "approval_required": true,
    "approval_groups": [
      {
        "email_addresses": [
          "test1@cloudflare.com",
          "test2@cloudflare.com"
        ],
        "approvals_needed": 1
      },
      {
        "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
        "approvals_needed": 3
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-policy-delete-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Access Policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete an Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE accounts/:identifier/access/apps/:uuid/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Access Keys Configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Access Keys Configuration defines the rotation policy for the keys that access will use to sign data.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-keys-configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-keys-configuration-get-access-keys-configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Get Access Keys Configuration 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get the Keys Configuration for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:identifier/access/keys
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/keys" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "key_rotation_interval_days": 30,
  "last_key_rotation_at": "2014-01-01T05:20:00.12345Z",
  "days_until_next_rotation": 1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-keys-configuration-update-access-keys-configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT Update Access Keys Configuration 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update the Keys Configuration for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:identifier/access/keys
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                key_rotation_interval_days
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • min value:21
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max value:365
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/keys" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"key_rotation_interval_days":30}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "key_rotation_interval_days": 30,
  "last_key_rotation_at": "2014-01-01T05:20:00.12345Z",
  "days_until_next_rotation": 1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-keys-configuration-rotate-access-keys
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Rotate Access Keys 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Perfoms a key rotation for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST accounts/:identifier/access/keys/rotate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/keys/rotate" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "key_rotation_interval_days": 30,
  "last_key_rotation_at": "2014-01-01T05:20:00.12345Z",
  "days_until_next_rotation": 1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Access Requests
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Access Requests returns user login and logout audit logs.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-requests
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                access-requests-access-requests-audit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Access Requests Audit 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Audit log of all authentication attempts. Details include the identity provider or login method and the IP address of the user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET accounts/:identifier/access/logs/access_requests
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                limit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limit the number of results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  direction
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Change the direction of the chronological sorting.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "desc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: desc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: desc, asc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  since
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The time on which to begin query
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2020-07-01T05:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  until
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The time on which to end qeury
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2020-10-01T05:20:00Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/access/logs/access_requests?limit=25&direction=desc&since=2020-07-01T05:20:00Z&until=2020-10-01T05:20:00Z" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "user_email": "michelle@example.com",
      "ip_address": "198.41.129.166",
      "app_uid": "df7e2w5f-02b7-4d9d-af26-8d1988fca630",
      "app_domain": "test.example.com/admin",
      "action": "login",
      "connection": "saml",
      "allowed": false,
      "created_at": "2014-01-01T05:20:00.12345Z",
      "ray_id": "187d944c61940c77"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Zone-Level Access Organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Access Organizations control the look and feel of your login page and the authentication domain it is located at. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-organizations-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zone-level-access-organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zone-level-access-organizations-access-organization-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Access Organization Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Fetch your Access Organization details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET zones/:identifier/access/organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/organizations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Widget Corps Internal Applications",
    "auth_domain": "test.cloudflareaccess.com",
    "login_design": {
      "background_color": "#c5ed1b",
      "text_color": "#c5ed1b",
      "logo_path": "https://example.com/logo.png"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  zone-level-access-organizations-create-access-organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Access Organization 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create a new Access Organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST zones/:identifier/access/organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of your Access Organization.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Widget Corps Internal Applications"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    auth_domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The domain that you will be redirected to on Access login attempts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "test.cloudflareaccess.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      login_design
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "background_color": "#c5ed1b",
  "text_color": "#c5ed1b",
  "logo_path": "https://example.com/logo.png"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/organizations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps Internal Applications","auth_domain":"test.cloudflareaccess.com","login_design":{"background_color":"#c5ed1b","text_color":"#c5ed1b","logo_path":"https://example.com/logo.png"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Widget Corps Internal Applications",
    "auth_domain": "test.cloudflareaccess.com",
    "login_design": {
      "background_color": "#c5ed1b",
      "text_color": "#c5ed1b",
      "logo_path": "https://example.com/logo.png"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zone-level-access-organizations-update-access-organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Access Organization 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update a configured Access Organization
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT zones/:identifier/access/organizations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The name of your Access Organization.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Widget Corps Internal Applications"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          auth_domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The domain that you will be redirected to on Access login attempts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "test.cloudflareaccess.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            login_design
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "background_color": "#c5ed1b",
  "text_color": "#c5ed1b",
  "logo_path": "https://example.com/logo.png"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/organizations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps Internal Applications","auth_domain":"test.cloudflareaccess.com","login_design":{"background_color":"#c5ed1b","text_color":"#c5ed1b","logo_path":"https://example.com/logo.png"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Widget Corps Internal Applications",
    "auth_domain": "test.cloudflareaccess.com",
    "login_design": {
      "background_color": "#c5ed1b",
      "text_color": "#c5ed1b",
      "logo_path": "https://example.com/logo.png"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zone-level-access-organizations-revoke-all-access-tokens-for-a-user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              POST Revoke all Access Tokens for a user 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Revoke any outstanding tokens issued for a specific user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              POST zones/:identifier/access/organizations/revoke_user
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              email
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The email of the user to revoke
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "test@example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/organizations/revoke_user" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"email":"test@example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "result": true
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Zone-Level Access Identity Providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Access identity providers are the services your user’s will login against to authenticate with your site. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-identity-providers-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-identity-providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-identity-providers-list-access-identity-providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET List Access Identity Providers 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List your Access Identity Providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:identifier/access/identity_providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/identity_providers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "Widget Corps OTP",
      "type": "onetimepin",
      "config": {}
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-identity-providers-access-identity-providers-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Access Identity Providers Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fetch your Access Identity Providers details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:identifier/access/identity_providers/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-identity-providers-create-access-identity-provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create Access Identity Provider 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a new Access Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST zones/:identifier/access/identity_providers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The name of your Access Identity Provider.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Widget Corps OTP"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "onetimepin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The configuration parameters for your identity provider. Please go to https://developers.cloudflare.com/access/configuring-identity-providers/ for more detailed examples.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/identity_providers" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps OTP","type":"onetimepin","config":{}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-level-access-identity-providers-update-access-identity-provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update Access Identity Provider 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update a configured Access Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:identifier/access/identity_providers/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of your Access Identity Provider.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Widget Corps OTP"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The type of Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "onetimepin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The configuration parameters for your identity provider. Please go to https://developers.cloudflare.com/access/configuring-identity-providers/ for more detailed examples.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Widget Corps OTP","type":"onetimepin","config":{}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-identity-providers-delete-access-identity-provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Access Identity Provider 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete an Access Identity Provider
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:identifier/access/identity_providers/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/identity_providers/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Widget Corps OTP",
    "type": "onetimepin",
    "config": {}
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Zone-Level Access Groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Access Groups allow you to define a set of users to which an application policy can be applied. You can reuse Access groups to quickly create policies that apply to the same set of users. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-groups-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-groups-list-access-groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Access Groups 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List Access Groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:identifier/access/groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/groups" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "name": "Allow devs",
      "include": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "exclude": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "require": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-groups-access-group-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Access Group Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch a single Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:identifier/access/groups/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-groups-create-access-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Access Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a new Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST zones/:identifier/access/groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the group. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/groups" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    zone-level-access-groups-update-access-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update Access Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update a configured Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT zones/:identifier/access/groups/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the group. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-groups-delete-access-group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Access Group 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete an Access Group
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE zones/:identifier/access/groups/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/groups/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Zone-Level Access Service Tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Access Service Tokens allow automated requests to reach protected domains. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-service-tokens-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-service-tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-service-tokens-list-access-service-tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Access Service Tokens 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List Access Service Tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:identifier/access/service_tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/service_tokens" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "CI/CD token",
      "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            zone-level-access-service-tokens-create-access-service-token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Access Service Token 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a new Access Service Token. Note: This is the only time you can get the client secret. Please save it somewhere secure.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST zones/:identifier/access/service_tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of your Access Service Token.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "CI/CD token"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/service_tokens" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"CI/CD token"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "CI/CD token",
    "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com",
    "client_secret": "bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              zone-level-access-service-tokens-update-access-service-token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT Update Access Service Token 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Update a configured Access Service Token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT zones/:identifier/access/service_tokens/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of your Access Service Token.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "CI/CD token"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/service_tokens/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"CI/CD token"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "CI/CD token",
    "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-service-tokens-delete-access-service-token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Access Service Token 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete an Access Service Token
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE zones/:identifier/access/service_tokens/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/service_tokens/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "CI/CD token",
    "client_id": "88bf3b6d86161464f6509f7219099e57.access.example.com"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Zone-Level Access Short-Lived Certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Short-lived certificates improve access security to infrastructure with ephemeral certificates. Serves as a replacement to traditional SSH key models. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-short-lived-certificates-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-short-lived-certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-short-lived-certificates-list-short-lived-certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET List Short-Lived Certificates 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List Short-Lived Certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:identifier/access/apps/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/apps/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9",
      "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
      "public_key": "ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-short-lived-certificates-short-lived-certificate-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Short-Lived Certificate Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fetch a single short-lived certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:identifier/access/apps/:uuid/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-short-lived-certificates-create-short-lived-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create Short-Lived Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a new short-lived certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST zones/:identifier/access/apps/:uuid/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-short-lived-certificates-delete-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete an Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE zones/:identifier/access/apps/:uuid/ca
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/ca" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Zone-Level Access Mutual TLS Authentication
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Mutual TLS authentication ensures that the traffic is secure and trusted in both directions between a client and server. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-mutual-tls-authentication-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-mutual-tls-authentication
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-mutual-tls-authentication-list-access-certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET List Access Certificates 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                List Access Certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:identifier/access/certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "expires_on": "2014-01-01T05:20:00.12345Z",
      "name": "Allow devs",
      "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
      "associated_hostnames": [
        "admin.example.com"
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-mutual-tls-authentication-access-certificate-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Access Certificate Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fetch a single Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:identifier/access/certificates/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
    "associated_hostnames": [
      "admin.example.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                zone-level-access-mutual-tls-authentication-create-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create a new Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST zones/:identifier/access/certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The name of the Certificate. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The Root CA for your certificates
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    associated_hostnames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The hostnames that will be prompted for this certificate.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  "admin.example.com"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","certificate":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","associated_hostnames":["admin.example.com"]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
    "associated_hostnames": [
      "admin.example.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-level-access-mutual-tls-authentication-update-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update a configured Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:identifier/access/certificates/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the Certificate. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        associated_hostnames
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The hostnames that will be prompted for this certificate.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  "admin.example.com"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Allow devs","associated_hostnames":["admin.example.com"]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "expires_on": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "fingerprint": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91",
    "associated_hostnames": [
      "admin.example.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-mutual-tls-authentication-delete-access-certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE Delete Access Certificate 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Delete an Access Certificate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE zones/:identifier/access/certificates/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/access/certificates/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Zone-Level Access Applications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access Applications define the routes that Access will block. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-applications-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications-list-access-applications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Access Applications 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List Access Applications for a zone
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:identifier/access/apps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
      "name": "Admin Site",
      "domain": "test.example.com/admin",
      "type": "self_hosted",
      "session_duration": "24h",
      "allowed_idps": [
        "699d98642c564d2e855e9661899b7252"
      ],
      "auto_redirect_to_identity": false,
      "enable_binding_cookie": false,
      "custom_deny_url": true,
      "http_only_cookie_attribute": "strict",
      "cors_headers": {
        "allowed_methods": [
          "GET"
        ],
        "allowed_origins": [
          "https://example.com"
        ],
        "allow_all_headers": true,
        "max_age": -1
      },
      "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
      "skip_interstitial": true
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications-access-applications-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Access Applications Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetch a single Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:identifier/access/apps/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
    "name": "Admin Site",
    "domain": "test.example.com/admin",
    "type": "self_hosted",
    "session_duration": "24h",
    "allowed_idps": [
      "699d98642c564d2e855e9661899b7252"
    ],
    "auto_redirect_to_identity": false,
    "enable_binding_cookie": false,
    "custom_deny_url": true,
    "http_only_cookie_attribute": "strict",
    "cors_headers": {
      "allowed_methods": [
        "GET"
      ],
      "allowed_origins": [
        "https://example.com"
      ],
      "allow_all_headers": true,
      "max_age": -1
    },
    "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
    "skip_interstitial": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications-create-access-application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Access Application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST zones/:identifier/access/apps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The domain and path that Access will block
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "test.example.com/admin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the Application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Admin Site"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              same_site_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines the same-site cookie setting for access tokens. Increases security against CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                custom_deny_message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Option that returns a custom error message when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  custom_deny_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Option that redirects to a custom URL when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    skip_interstitial
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Defines whether or not access will skip the authorization interstitial when using the cli.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    auto_redirect_to_identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Option to skip identity provider selection if only one is configured in allowed_idps.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cors_headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "allowed_methods": [
    "GET"
  ],
  "allowed_origins": [
    "https://example.com"
  ],
  "allow_all_headers": true,
  "max_age": -1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allowed_idps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The identity providers selected for application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  "699d98642c564d2e855e9661899b7252"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The application type.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "self_hosted"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: self_hosted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: self_hosted, saas, ssh, vnc, file
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enable_binding_cookie
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Option that provides increased security against compromised authorization tokens and CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logo_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defines the image URL for the logo shown in the app launcher dashboard.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Defines the amount of time that the tokens issued for this application will be valid. Must be in the format '300ms' or '2h45m'. Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "24h"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 24h
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          http_only_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Defines whether or not access tokens will be set as http_only cookies. Increases security against XSS attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "strict"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Admin Site","domain":"test.example.com/admin","type":"self_hosted","session_duration":"24h","allowed_idps":["699d98642c564d2e855e9661899b7252"],"auto_redirect_to_identity":false,"enable_binding_cookie":false,"custom_deny_url":true,"http_only_cookie_attribute":"strict","cors_headers":{"allowed_methods":["GET"],"allowed_origins":["https://example.com"],"allow_all_headers":true,"max_age":-1},"logo_url":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","skip_interstitial":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
    "name": "Admin Site",
    "domain": "test.example.com/admin",
    "type": "self_hosted",
    "session_duration": "24h",
    "allowed_idps": [
      "699d98642c564d2e855e9661899b7252"
    ],
    "auto_redirect_to_identity": false,
    "enable_binding_cookie": false,
    "custom_deny_url": true,
    "http_only_cookie_attribute": "strict",
    "cors_headers": {
      "allowed_methods": [
        "GET"
      ],
      "allowed_origins": [
        "https://example.com"
      ],
      "allow_all_headers": true,
      "max_age": -1
    },
    "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
    "skip_interstitial": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications-update-access-application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update Access Application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Update a configured Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT zones/:identifier/access/apps/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The domain and path that Access will block
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "test.example.com/admin"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the Application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Admin Site"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              same_site_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines the same-site cookie setting for access tokens. Increases security against CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                custom_deny_message
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Option that returns a custom error message when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  custom_deny_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Option that redirects to a custom URL when a user is denied access to the application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    skip_interstitial
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Defines whether or not access will skip the authorization interstitial when using the cli.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    auto_redirect_to_identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Option to skip identity provider selection if only one is configured in allowed_idps.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cors_headers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "allowed_methods": [
    "GET"
  ],
  "allowed_origins": [
    "https://example.com"
  ],
  "allow_all_headers": true,
  "max_age": -1
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allowed_idps
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The identity providers selected for application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  "699d98642c564d2e855e9661899b7252"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enable_binding_cookie
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Option that provides increased security against compromised authorization tokens and CSRF attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logo_url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defines the image URL for the logo shown in the app launcher dashboard.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Defines the amount of time that the tokens issued for this application will be valid. Must be in the format '300ms' or '2h45m'. Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "24h"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 24h
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          http_only_cookie_attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Defines whether or not access tokens will be set as http_only cookies. Increases security against XSS attacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "strict"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Admin Site","domain":"test.example.com/admin","session_duration":"24h","allowed_idps":["699d98642c564d2e855e9661899b7252"],"auto_redirect_to_identity":false,"enable_binding_cookie":false,"custom_deny_url":true,"http_only_cookie_attribute":"strict","cors_headers":{"allowed_methods":["GET"],"allowed_origins":["https://example.com"],"allow_all_headers":true,"max_age":-1},"logo_url":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","skip_interstitial":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "aud": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
    "name": "Admin Site",
    "domain": "test.example.com/admin",
    "type": "self_hosted",
    "session_duration": "24h",
    "allowed_idps": [
      "699d98642c564d2e855e9661899b7252"
    ],
    "auto_redirect_to_identity": false,
    "enable_binding_cookie": false,
    "custom_deny_url": true,
    "http_only_cookie_attribute": "strict",
    "cors_headers": {
      "allowed_methods": [
        "GET"
      ],
      "allowed_origins": [
        "https://example.com"
      ],
      "allow_all_headers": true,
      "max_age": -1
    },
    "logo_url": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg",
    "skip_interstitial": true
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications-delete-access-application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE Delete Access Application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Delete an Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DELETE zones/:identifier/access/apps/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-applications-revoke-access-tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Revoke Access Tokens 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Revoke any outstanding tokens issued for the Application.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST zones/:identifier/access/apps/:uuid/revoke_tokens
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/revoke_tokens" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Zone-Level Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Access Policies define the users or groups who can, or cannot, reach the Application Resource. (NOTE: it's recommended that the account route namespace is used instead: https://api.cloudflare.com/#access-policy-properties.)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-policy-list-access-policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Access Policies 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List Access Policies for an Access Application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:identifier/access/apps/:uuid/policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "precedence": 1,
      "decision": "allow",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "name": "Allow devs",
      "include": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "exclude": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "require": [
        {
          "email": {
            "email": "test@example.com"
          }
        }
      ],
      "purpose_justification_required": true,
      "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
      "approval_required": true,
      "approval_groups": [
        {
          "email_addresses": [
            "test1@cloudflare.com",
            "test2@cloudflare.com"
          ],
          "approvals_needed": 1
        },
        {
          "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
          "approvals_needed": 3
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-policy-access-policy-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Access Policy Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetch a single Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:identifier/access/apps/:uuid/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "precedence": 1,
    "decision": "allow",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "purpose_justification_required": true,
    "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
    "approval_required": true,
    "approval_groups": [
      {
        "email_addresses": [
          "test1@cloudflare.com",
          "test2@cloudflare.com"
        ],
        "approvals_needed": 1
      },
      {
        "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
        "approvals_needed": 3
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          zone-level-access-policy-create-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Access Policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Create a new Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST zones/:identifier/access/apps/:uuid/policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the policy. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              decision
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Defines the action Access will take if the policy matches the user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "allow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: allow, deny, non_identity, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                precedence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The unique precedence for policies on a single application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  purpose_justification_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Defines whether or not the user is prompted for a justification when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  approval_groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The list of approval groups that must approve the access request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "email_addresses": [
      "test1@cloudflare.com",
      "test2@cloudflare.com"
    ],
    "approvals_needed": 1
  },
  {
    "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
    "approvals_needed": 3
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    purpose_justification_prompt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The text the user will be prompted with when a purpose justification is required.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Please enter a justification for entering this protected domain"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        approval_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defines whether or not the user needs to request approval when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"precedence":1,"decision":"allow","name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}],"purpose_justification_required":true,"purpose_justification_prompt":"Please enter a justification for entering this protected domain","approval_required":true,"approval_groups":[{"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"],"approvals_needed":1},{"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34","approvals_needed":3}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "precedence": 1,
    "decision": "allow",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "purpose_justification_required": true,
    "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
    "approval_required": true,
    "approval_groups": [
      {
        "email_addresses": [
          "test1@cloudflare.com",
          "test2@cloudflare.com"
        ],
        "approvals_needed": 1
      },
      {
        "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
        "approvals_needed": 3
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        zone-level-access-policy-update-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Access Policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update a configured Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT zones/:identifier/access/apps/:uuid/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The include policy works like an OR logical operator. The user must satisfy one of the rules in includes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name of the policy. Only used in the UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Allow devs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            decision
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines the action Access will take if the policy matches the user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "allow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: allow, deny, non_identity, bypass
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            require
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The require policy works like a AND logical operator. The user must satisfy all of the rules in require.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              precedence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The unique precedence for policies on a single application
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                purpose_justification_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Defines whether or not the user is prompted for a justification when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                approval_groups
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The list of approval groups that must approve the access request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "email_addresses": [
      "test1@cloudflare.com",
      "test2@cloudflare.com"
    ],
    "approvals_needed": 1
  },
  {
    "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
    "approvals_needed": 3
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  purpose_justification_prompt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The text the user will be prompted with when a purpose justification is required.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Please enter a justification for entering this protected domain"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The exclude policy works like a NOT logical operator. The user must not satisfy all of the rules in exclude.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [
  {
    "email": {
      "email": "test@example.com"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      approval_required
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Defines whether or not the user needs to request approval when this policy is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"precedence":1,"decision":"allow","name":"Allow devs","include":[{"email":{"email":"test@example.com"}}],"exclude":[{"email":{"email":"test@example.com"}}],"require":[{"email":{"email":"test@example.com"}}],"purpose_justification_required":true,"purpose_justification_prompt":"Please enter a justification for entering this protected domain","approval_required":true,"approval_groups":[{"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"],"approvals_needed":1},{"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34","approvals_needed":3}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "precedence": 1,
    "decision": "allow",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "name": "Allow devs",
    "include": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "exclude": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "require": [
      {
        "email": {
          "email": "test@example.com"
        }
      }
    ],
    "purpose_justification_required": true,
    "purpose_justification_prompt": "Please enter a justification for entering this protected domain",
    "approval_required": true,
    "approval_groups": [
      {
        "email_addresses": [
          "test1@cloudflare.com",
          "test2@cloudflare.com"
        ],
        "approvals_needed": 1
      },
      {
        "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34",
        "approvals_needed": 3
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      zone-level-access-policy-delete-access-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete Access Policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete an Access Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE zones/:identifier/access/apps/:uuid/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/zones/699d98642c564d2e855e9661899b7252/access/apps/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Teams Lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Lists are referenced when creating Secure Web Gateway policies.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      teams-lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      teams-lists-list-teams-lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Teams Lists 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List Teams Lists for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/gateway/lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "Admin Serial Numbers",
      "description": "The serial numbers for administrators",
      "type": "SERIAL",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z",
      "count": 20
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      teams-lists-teams-list-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Teams List Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Fetch a single Teams List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/gateway/lists/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Admin Serial Numbers",
    "description": "The serial numbers for administrators",
    "type": "SERIAL",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "count": 20
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      teams-lists-teams-list-items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Teams List Items 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Fetch all items of a single Teams List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/gateway/lists/:uuid/items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists/f174e90a-fafe-4643-bbbc-4a0ed4fc8415/items" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    [
      {
        "value": "8GE8721REF",
        "created_at": "2014-01-01T05:20:00.12345Z"
      }
    ]
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      teams-lists-create-teams-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create Teams List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a new Teams List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST accounts/:identifier/gateway/lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Admin Serial Numbers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The type of List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "SERIAL"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: SERIAL, URL, DOMAIN, EMAIL
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The description of the List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "The serial numbers for administrators"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          items
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The items in the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  {
    "value": "8GE8721REF",
    "created_at": "2014-01-01T05:20:00.12345Z"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Admin Serial Numbers","description":"The serial numbers for administrators","type":"SERIAL","items":[{"value":"8GE8721REF","created_at":"2014-01-01T05:20:00.12345Z"}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Admin Serial Numbers",
    "description": "The serial numbers for administrators",
    "type": "SERIAL",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "items": [
      {
        "value": "8GE8721REF",
        "created_at": "2014-01-01T05:20:00.12345Z"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            teams-lists-update-teams-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update Teams List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update a configured Teams List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT accounts/:identifier/gateway/lists/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Admin Serial Numbers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The description of the List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "The serial numbers for administrators"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Admin Serial Numbers","description":"The serial numbers for administrators"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Admin Serial Numbers",
    "description": "The serial numbers for administrators",
    "type": "SERIAL",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "count": 20
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                teams-lists-patch-teams-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH Patch Teams List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Append or remove an item from a configured Teams List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH accounts/:identifier/gateway/lists/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                append
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The items in the List.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "value": "8GE8721REF",
    "created_at": "2014-01-01T05:20:00.12345Z"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  remove
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A list of the item values you want to remove.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  "8GE8721REF"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"append":[{"value":"8GE8721REF","created_at":"2014-01-01T05:20:00.12345Z"}],"remove":["8GE8721REF"]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Admin Serial Numbers",
    "description": "The serial numbers for administrators",
    "type": "SERIAL",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z",
    "count": 20
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    teams-lists-delete-teams-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Teams List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete a Teams List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:identifier/gateway/lists/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/lists/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {}
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Teams Locations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Locations are a collection of resources like network ranges or destination IPs that can map to a physical location like an office or special teams when creating Secure Web Gateway policies.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    teams-locations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    teams-locations-list-teams-locations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Teams Locations 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List Teams Locations for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/gateway/locations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/locations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "ed35569b41ce4d1facfe683550f54086",
      "name": "Austin Office Location",
      "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "networks": [
        "192.0.2.1"
      ],
      "doh_subdomain": "oli3n9zkz5",
      "client_default": "false",
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    teams-locations-teams-location-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET Teams Location Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Fetch a single Teams Location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/gateway/locations/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/locations/ed35569b41ce4d1facfe683550f54086" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed35569b41ce4d1facfe683550f54086",
    "name": "Austin Office Location",
    "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "networks": [
      "192.0.2.1"
    ],
    "doh_subdomain": "oli3n9zkz5",
    "client_default": "false",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    teams-locations-create-teams-location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create Teams Location 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a new Teams Location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:identifier/gateway/locations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the Location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Austin Office Location"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      networks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A list of network ranges that requests from this location would originate from
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [
  "192.0.2.1"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        client_default
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set if the location is the default one
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "false"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/locations" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Austin Office Location","networks":["192.0.2.1"],"client_default":"false"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed35569b41ce4d1facfe683550f54086",
    "name": "Austin Office Location",
    "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "networks": [
      "192.0.2.1"
    ],
    "doh_subdomain": "oli3n9zkz5",
    "client_default": "false",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        teams-locations-update-teams-location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT Update Teams Location 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Update a configured Teams Location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PUT accounts/:identifier/gateway/locations/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The name of the Location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Austin Office Location"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          networks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A list of network ranges that requests from this location would originate from
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  "192.0.2.1"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            client_default
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set if the location is the default one
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "false"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/locations/ed35569b41ce4d1facfe683550f54086" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Austin Office Location","networks":["192.0.2.1"],"client_default":"false"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ed35569b41ce4d1facfe683550f54086",
    "name": "Austin Office Location",
    "ip": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
    "networks": [
      "192.0.2.1"
    ],
    "doh_subdomain": "oli3n9zkz5",
    "client_default": "false",
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            teams-locations-delete-teams-location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Teams Location 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete a Teams Location
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:identifier/gateway/locations/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/locations/ed35569b41ce4d1facfe683550f54086" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {}
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Teams Rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Secure Web Gateway rules are a set of expressions(conditions) that evaluate at various phases of your internet traffic, to determine if a specific action has to be performed. These expressions can be evaluated to a true/false value and based on the evaluation result, an associated action, like whether to reject the request, or allow it, or override it, or browser isolate it is applied.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            teams-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            teams-rules-list-teams-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Teams Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List Teams Rules for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:identifier/gateway/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "block bad websites",
      "description": "Block the bad websites based on host name",
      "precedence": "1",
      "enabled": "true",
      "action": "allow",
      "filters": "[http]",
      "traffic": "http.request.host == \"example.com\"",
      "identity": "any(identity.groups.name[*] in {\"finance\"})",
      "rule_settings": {
        "block_page_enabled": "true",
        "block_reason": "This website is a security risk",
        "override_host": "example.com",
        "override_ips": "[1.1.1.1, 2.2.2.2]",
        "l4override": {
          "ip": "1.1.1.1",
          "port": "80"
        },
        "add_headers": {
          "X-Custom-Header-Name": [
            "somecustomvalue"
          ],
          "My-Next-Header": [
            "foo",
            "bar"
          ]
        },
        "ip_categories": true
      },
      "created_at": "2014-01-01T05:20:00.12345Z",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            teams-rules-teams-rule-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Teams Rule Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch a single Teams Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:identifier/gateway/rules/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/rules/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "block bad websites",
    "description": "Block the bad websites based on host name",
    "precedence": "1",
    "enabled": "true",
    "action": "allow",
    "filters": "[http]",
    "traffic": "http.request.host == \"example.com\"",
    "identity": "any(identity.groups.name[*] in {\"finance\"})",
    "rule_settings": {
      "block_page_enabled": "true",
      "block_reason": "This website is a security risk",
      "override_host": "example.com",
      "override_ips": "[1.1.1.1, 2.2.2.2]",
      "l4override": {
        "ip": "1.1.1.1",
        "port": "80"
      },
      "add_headers": {
        "X-Custom-Header-Name": [
          "somecustomvalue"
        ],
        "My-Next-Header": [
          "foo",
          "bar"
        ]
      },
      "ip_categories": true
    },
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            teams-rules-create-teams-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Teams Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Create a new Teams Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST accounts/:identifier/gateway/rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The name of the Rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "block bad websites"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The action to preform when the associated traffic and identity expressions are either absent or evaluate to 'true'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "allow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: on, off, allow, block, scan, noscan, safesearch, ytrestricted, isolate, noisolate, override, l4_override
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set if the rule is enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "true"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rule_settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Additional settings that modify the rule's action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "block_page_enabled": "true",
  "block_reason": "This website is a security risk",
  "override_host": "example.com",
  "override_ips": "[1.1.1.1, 2.2.2.2]",
  "l4override": {
    "ip": "1.1.1.1",
    "port": "80"
  },
  "add_headers": {
    "X-Custom-Header-Name": [
      "somecustomvalue"
    ],
    "My-Next-Header": [
      "foo",
      "bar"
    ]
  },
  "ip_categories": true
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                precedence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Precedence sets the ordering of the rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The protocol or layer to evaluate the traffic and identity expressions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "[http]"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The description of the Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Block the bad websites based on host name"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      traffic
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The wirefilter expression to be used for traffic matching
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "http.request.host == \"example.com\""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The wirefilter expression to be used for identity matching
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "any(identity.groups.name[*] in {\"finance\"})"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/rules" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"block bad websites","description":"Block the bad websites based on host name","action":"allow","filters":"[http]","enabled":"true","precedence":"1","traffic":"http.request.host == \"example.com\"","identity":"any(identity.groups.name[*] in {\"finance\"})","rule_settings":{"block_page_enabled":"true","block_reason":"This website is a security risk","override_host":"example.com","override_ips":"[1.1.1.1, 2.2.2.2]","l4override":{"ip":"1.1.1.1","port":"80"},"add_headers":{"X-Custom-Header-Name":["somecustomvalue"],"My-Next-Header":["foo","bar"]},"ip_categories":true}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "block bad websites",
    "description": "Block the bad websites based on host name",
    "precedence": "1",
    "enabled": "true",
    "action": "allow",
    "filters": "[http]",
    "traffic": "http.request.host == \"example.com\"",
    "identity": "any(identity.groups.name[*] in {\"finance\"})",
    "rule_settings": {
      "block_page_enabled": "true",
      "block_reason": "This website is a security risk",
      "override_host": "example.com",
      "override_ips": "[1.1.1.1, 2.2.2.2]",
      "l4override": {
        "ip": "1.1.1.1",
        "port": "80"
      },
      "add_headers": {
        "X-Custom-Header-Name": [
          "somecustomvalue"
        ],
        "My-Next-Header": [
          "foo",
          "bar"
        ]
      },
      "ip_categories": true
    },
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          teams-rules-update-teams-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update Teams Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Update a configured Teams Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT accounts/:identifier/gateway/rules/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name of the Rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "block bad websites"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The action to preform when the associated traffic and identity expressions are either absent or evaluate to 'true'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "allow"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: on, off, allow, block, scan, noscan, safesearch, ytrestricted, isolate, noisolate, override, l4_override
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set if the rule is enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "true"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rule_settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Additional settings that modify the rule's action
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "block_page_enabled": "true",
  "block_reason": "This website is a security risk",
  "override_host": "example.com",
  "override_ips": "[1.1.1.1, 2.2.2.2]",
  "l4override": {
    "ip": "1.1.1.1",
    "port": "80"
  },
  "add_headers": {
    "X-Custom-Header-Name": [
      "somecustomvalue"
    ],
    "My-Next-Header": [
      "foo",
      "bar"
    ]
  },
  "ip_categories": true
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              precedence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Precedence sets the ordering of the rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The protocol or layer to evaluate the traffic and identity expressions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[http]"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The description of the Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Block the bad websites based on host name"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    traffic
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The wirefilter expression to be used for traffic matching
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "http.request.host == \"example.com\""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identity
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The wirefilter expression to be used for identity matching
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "any(identity.groups.name[*] in {\"finance\"})"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/rules/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"block bad websites","description":"Block the bad websites based on host name","action":"allow","filters":"[http]","enabled":"true","precedence":"1","traffic":"http.request.host == \"example.com\"","identity":"any(identity.groups.name[*] in {\"finance\"})","rule_settings":{"block_page_enabled":"true","block_reason":"This website is a security risk","override_host":"example.com","override_ips":"[1.1.1.1, 2.2.2.2]","l4override":{"ip":"1.1.1.1","port":"80"},"add_headers":{"X-Custom-Header-Name":["somecustomvalue"],"My-Next-Header":["foo","bar"]},"ip_categories":true}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "block bad websites",
    "description": "Block the bad websites based on host name",
    "precedence": "1",
    "enabled": "true",
    "action": "allow",
    "filters": "[http]",
    "traffic": "http.request.host == \"example.com\"",
    "identity": "any(identity.groups.name[*] in {\"finance\"})",
    "rule_settings": {
      "block_page_enabled": "true",
      "block_reason": "This website is a security risk",
      "override_host": "example.com",
      "override_ips": "[1.1.1.1, 2.2.2.2]",
      "l4override": {
        "ip": "1.1.1.1",
        "port": "80"
      },
      "add_headers": {
        "X-Custom-Header-Name": [
          "somecustomvalue"
        ],
        "My-Next-Header": [
          "foo",
          "bar"
        ]
      },
      "ip_categories": true
    },
    "created_at": "2014-01-01T05:20:00.12345Z",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        teams-rules-delete-teams-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE Delete Teams Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete a Teams Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE accounts/:identifier/gateway/rules/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/gateway/rules/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {}
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Device Posture Rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Device posture rules configure security policies for device posture checks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        device-posture-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        device-posture-rules-list-device-posture-rules
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET List Device Posture Rules 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List Device Posture Rules for an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:identifier/devices/posture
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/posture" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "type": "file",
      "name": "Admin Serial Numbers",
      "description": "The rule for admin serial numbers",
      "schedule": "1h",
      "match": [
        {
          "platform": "windows"
        }
      ],
      "input": {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        device-posture-rules-device-posture-rules-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Device Posture Rules Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Fetch a single Device Posture Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:identifier/devices/posture/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/posture/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "type": "file",
    "name": "Admin Serial Numbers",
    "description": "The rule for admin serial numbers",
    "schedule": "1h",
    "match": [
      {
        "platform": "windows"
      }
    ],
    "input": {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        device-posture-rules-create-device-posture-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST Create Device Posture Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a new Device Posture Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST accounts/:identifier/devices/posture
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The type of Device Posture Rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "file"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: file, application, serial_number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The name of the Device Posture Rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Admin Serial Numbers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The description of the Device Posture Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "The rule for admin serial numbers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            schedule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tells the client when to run the device posture check.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "1h"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The conditions that the client must match to run the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  {
    "platform": "windows"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The value to be checked against.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X POST "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/posture" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"file","name":"Admin Serial Numbers","description":"The rule for admin serial numbers","schedule":"1h","match":[{"platform":"windows"}],"input":{"id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "type": "file",
    "name": "Admin Serial Numbers",
    "description": "The rule for admin serial numbers",
    "schedule": "1h",
    "match": [
      {
        "platform": "windows"
      }
    ],
    "input": {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  device-posture-rules-update-device-posture-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT Update Device Posture Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Update a Device Posture Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:identifier/devices/posture/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of Device Posture Rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "file"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: file, application, serial_number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the Device Posture Rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Admin Serial Numbers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The description of the Device Posture Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "The rule for admin serial numbers"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schedule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tells the client when to run the device posture check.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "1h"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        match
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The conditions that the client must match to run the rule.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  {
    "platform": "windows"
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          input
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The value to be checked against.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/posture/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"type":"file","name":"Admin Serial Numbers","description":"The rule for admin serial numbers","schedule":"1h","match":[{"platform":"windows"}],"input":{"id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "type": "file",
    "name": "Admin Serial Numbers",
    "description": "The rule for admin serial numbers",
    "schedule": "1h",
    "match": [
      {
        "platform": "windows"
      }
    ],
    "input": {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            device-posture-rules-delete-device-posture-rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE Delete Device Posture Rule 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Delete a Device Posture Rule
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DELETE accounts/:identifier/devices/posture/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/posture/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Device Policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Teams device policy configuration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            device-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            device-policy-set-local-domain-fallback-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Set Local Domain Fallback List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Set the list of domains resolved locally by WARP clients
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT accounts/:identifier/devices/policy/fallback_domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            suffix
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The domain suffix to match when resolving locally.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A description of the fallback domain, displayed in the client UI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Domain bypass for local development"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/policy/fallback_domains" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"suffix":"example.com","description":"Domain bypass for local development"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "suffix": "example.com",
      "description": "Domain bypass for local development"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              device-policy-get-local-domain-fallback-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET Get Local Domain Fallback List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Get the list of domains resolved locally by WARP clients
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET accounts/:identifier/devices/policy/fallback_domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/policy/fallback_domains" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "suffix": "example.com",
      "description": "Domain bypass for local development"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              device-policy-set-split-tunnel-exclude-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT Set Split Tunnel Exclude List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Set the list of routes excluded from the WARP client's tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PUT accounts/:identifier/devices/policy/exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The address in CIDR format to exclude from the tunnel. If address is present, host must not be present.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "192.0.2.0/24"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A description of the split tunnel item, displayed in the client UI.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Exclude testing domains from the tunnel"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The domain name to exclude from the tunnel. If host is present, address must not be present.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "*.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/policy/exclude" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"address":"192.0.2.0/24","description":"Exclude testing domains from the tunnel"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "address": "192.0.2.0/24",
      "description": "Exclude testing domains from the tunnel"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  device-policy-get-split-tunnel-exclude-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Get Split Tunnel Exclude List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get the list of routes excluded from the WARP client's tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:identifier/devices/policy/exclude
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/policy/exclude" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "address": "192.0.2.0/24",
      "description": "Exclude testing domains from the tunnel"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  device-policy-set-split-tunnel-include-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT Set Split Tunnel Include List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Set the list of routes included in the WARP client's tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PUT accounts/:identifier/devices/policy/include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The address in CIDR format to include in the tunnel. If address is present, host must not be present.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "192.0.2.0/24"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A description of the split tunnel item, displayed in the client UI
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Include testing domains from the tunnel"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The domain name to include in the tunnel. If host is present, address must not be present.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "*.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PUT "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/policy/include" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '[{"address":"192.0.2.0/24","description":"Include testing domains from the tunnel"}]'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "address": "192.0.2.0/24",
      "description": "Include testing domains from the tunnel"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      device-policy-get-split-tunnel-include-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get Split Tunnel Include List 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Get the list of routes included in the WARP client's tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:identifier/devices/policy/include
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/699d98642c564d2e855e9661899b7252/devices/policy/include" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "address": "192.0.2.0/24",
      "description": "Include testing domains from the tunnel"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Health Checks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Zone-level stand-alone health checks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      health-checks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      health-checks-list-health-checks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Health Checks 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List configured health checks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_identifier/healthchecks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Number of items per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Filter health checks with name partially matching this string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "server-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks?page=1&per_page=25&name=server-1" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "699d98642c564d2e855e9661899b7252",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "name": "server-1",
      "description": "Health check for www.example.com",
      "suspended": false,
      "notification": {
        "suspended": false,
        "email_addresses": [
          "alert@example.com",
          "oncall@example.com"
        ],
        "trigger": "FAIL"
      },
      "check_regions": [
        "WEU",
        "ENAM"
      ],
      "type": "HTTPS",
      "consecutive_successes": 1,
      "consecutive_fails": 1,
      "http_config": {
        "method": "GET",
        "port": 80,
        "path": "/health",
        "expected_codes": [
          "2xx",
          "302"
        ],
        "expected_body": "success",
        "follow_redirects": false,
        "allow_insecure": false,
        "header": {
          "Host": [
            "example.com"
          ],
          "X-App-ID": [
            "abc123"
          ]
        }
      },
      "tcp_config": {
        "method": "connection_established",
        "port": 80
      },
      "timeout": 5,
      "retries": 2,
      "interval": 60,
      "address": "www.example.com",
      "status": "healthy",
      "failure_reason": ""
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        health-checks-create-health-check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST Create Health Check 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Create a new health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST zones/:zone_identifier/healthchecks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "server-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The hostname or IP address of the origin server to run health checks on.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consecutive_fails
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The number of consecutive fails required from a health check before changing the health to unhealthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tcp_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters specific to TCP health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "method": "connection_established",
  "port": 80
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The timeout (in seconds) before marking the health check as failed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                notification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Notifications are sent when the status of a health check changes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "suspended": false,
  "email_addresses": [
    "alert@example.com",
    "oncall@example.com"
  ],
  "trigger": "FAIL"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  http_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters specific to an HTTP or HTTPS health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "method": "GET",
  "port": 80,
  "path": "/health",
  "expected_codes": [
    "2xx",
    "302"
  ],
  "expected_body": "success",
  "follow_redirects": false,
  "allow_insecure": false,
  "header": {
    "Host": [
      "example.com"
    ],
    "X-App-ID": [
      "abc123"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "HTTPS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: HTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    If suspended, no health checks are sent to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consecutive_successes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of consecutive successes required from a health check before changing the health to healthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A human-readable description of the health check.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Health check for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "server-1",
    "description": "Health check for www.example.com",
    "suspended": false,
    "notification": {
      "suspended": false,
      "email_addresses": [
        "alert@example.com",
        "oncall@example.com"
      ],
      "trigger": "FAIL"
    },
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "type": "HTTPS",
    "consecutive_successes": 1,
    "consecutive_fails": 1,
    "http_config": {
      "method": "GET",
      "port": 80,
      "path": "/health",
      "expected_codes": [
        "2xx",
        "302"
      ],
      "expected_body": "success",
      "follow_redirects": false,
      "allow_insecure": false,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      }
    },
    "tcp_config": {
      "method": "connection_established",
      "port": 80
    },
    "timeout": 5,
    "retries": 2,
    "interval": 60,
    "address": "www.example.com",
    "status": "healthy",
    "failure_reason": ""
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      health-checks-health-check-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Health Check Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Fetch a single configured health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_identifier/healthchecks/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "server-1",
    "description": "Health check for www.example.com",
    "suspended": false,
    "notification": {
      "suspended": false,
      "email_addresses": [
        "alert@example.com",
        "oncall@example.com"
      ],
      "trigger": "FAIL"
    },
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "type": "HTTPS",
    "consecutive_successes": 1,
    "consecutive_fails": 1,
    "http_config": {
      "method": "GET",
      "port": 80,
      "path": "/health",
      "expected_codes": [
        "2xx",
        "302"
      ],
      "expected_body": "success",
      "follow_redirects": false,
      "allow_insecure": false,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      }
    },
    "tcp_config": {
      "method": "connection_established",
      "port": 80
    },
    "timeout": 5,
    "retries": 2,
    "interval": 60,
    "address": "www.example.com",
    "status": "healthy",
    "failure_reason": ""
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      health-checks-update-health-check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT Update Health Check 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Update a configured health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PUT zones/:zone_identifier/healthchecks/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "server-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The hostname or IP address of the origin server to run health checks on.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          consecutive_fails
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The number of consecutive fails required from a health check before changing the health to unhealthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tcp_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters specific to TCP health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "method": "connection_established",
  "port": 80
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The timeout (in seconds) before marking the health check as failed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              notification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Notifications are sent when the status of a health check changes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "suspended": false,
  "email_addresses": [
    "alert@example.com",
    "oncall@example.com"
  ],
  "trigger": "FAIL"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                http_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters specific to an HTTP or HTTPS health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "method": "GET",
  "port": 80,
  "path": "/health",
  "expected_codes": [
    "2xx",
    "302"
  ],
  "expected_body": "success",
  "follow_redirects": false,
  "allow_insecure": false,
  "header": {
    "Host": [
      "example.com"
    ],
    "X-App-ID": [
      "abc123"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "HTTPS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: HTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If suspended, no health checks are sent to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  consecutive_successes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The number of consecutive successes required from a health check before changing the health to healthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A human-readable description of the health check.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Health check for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "server-1",
    "description": "Health check for www.example.com",
    "suspended": false,
    "notification": {
      "suspended": false,
      "email_addresses": [
        "alert@example.com",
        "oncall@example.com"
      ],
      "trigger": "FAIL"
    },
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "type": "HTTPS",
    "consecutive_successes": 1,
    "consecutive_fails": 1,
    "http_config": {
      "method": "GET",
      "port": 80,
      "path": "/health",
      "expected_codes": [
        "2xx",
        "302"
      ],
      "expected_body": "success",
      "follow_redirects": false,
      "allow_insecure": false,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      }
    },
    "tcp_config": {
      "method": "connection_established",
      "port": 80
    },
    "timeout": 5,
    "retries": 2,
    "interval": 60,
    "address": "www.example.com",
    "status": "healthy",
    "failure_reason": ""
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    health-checks-patch-health-check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PATCH Patch Health Check 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Patch a configured health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PATCH zones/:zone_identifier/healthchecks/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "server-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The hostname or IP address of the origin server to run health checks on.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        consecutive_fails
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of consecutive fails required from a health check before changing the health to unhealthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tcp_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters specific to TCP health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "method": "connection_established",
  "port": 80
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The timeout (in seconds) before marking the health check as failed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            notification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Notifications are sent when the status of a health check changes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "suspended": false,
  "email_addresses": [
    "alert@example.com",
    "oncall@example.com"
  ],
  "trigger": "FAIL"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              http_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters specific to an HTTP or HTTPS health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "method": "GET",
  "port": 80,
  "path": "/health",
  "expected_codes": [
    "2xx",
    "302"
  ],
  "expected_body": "success",
  "follow_redirects": false,
  "allow_insecure": false,
  "header": {
    "Host": [
      "example.com"
    ],
    "X-App-ID": [
      "abc123"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "HTTPS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: HTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If suspended, no health checks are sent to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                consecutive_successes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The number of consecutive successes required from a health check before changing the health to healthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A human-readable description of the health check.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Health check for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "server-1",
    "description": "Health check for www.example.com",
    "suspended": false,
    "notification": {
      "suspended": false,
      "email_addresses": [
        "alert@example.com",
        "oncall@example.com"
      ],
      "trigger": "FAIL"
    },
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "type": "HTTPS",
    "consecutive_successes": 1,
    "consecutive_fails": 1,
    "http_config": {
      "method": "GET",
      "port": 80,
      "path": "/health",
      "expected_codes": [
        "2xx",
        "302"
      ],
      "expected_body": "success",
      "follow_redirects": false,
      "allow_insecure": false,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      }
    },
    "tcp_config": {
      "method": "connection_established",
      "port": 80
    },
    "timeout": 5,
    "retries": 2,
    "interval": 60,
    "address": "www.example.com",
    "status": "healthy",
    "failure_reason": ""
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  health-checks-delete-health-check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete Health Check 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete a health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE zones/:zone_identifier/healthchecks/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  health-checks-create-preview-health-check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Preview Health Check 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Create a new preview health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST zones/:zone_identifier/healthchecks/preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "server-1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The hostname or IP address of the origin server to run health checks on.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consecutive_fails
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The number of consecutive fails required from a health check before changing the health to unhealthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tcp_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters specific to TCP health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "method": "connection_established",
  "port": 80
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The timeout (in seconds) before marking the health check as failed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interval
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retries
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        check_regions
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        arraynull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  "WEU",
  "ENAM"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Notifications are sent when the status of a health check changes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "suspended": false,
  "email_addresses": [
    "alert@example.com",
    "oncall@example.com"
  ],
  "trigger": "FAIL"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            http_config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            objectnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters specific to an HTTP or HTTPS health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "method": "GET",
  "port": 80,
  "path": "/health",
  "expected_codes": [
    "2xx",
    "302"
  ],
  "expected_body": "success",
  "follow_redirects": false,
  "allow_insecure": false,
  "header": {
    "Host": [
      "example.com"
    ],
    "X-App-ID": [
      "abc123"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "HTTPS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: HTTP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If suspended, no health checks are sent to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              consecutive_successes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of consecutive successes required from a health check before changing the health to healthy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A human-readable description of the health check.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Health check for www.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/preview" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"server-1","description":"Health check for www.example.com","suspended":false,"notification":{"suspended":false,"email_addresses":["alert@example.com","oncall@example.com"],"trigger":"FAIL"},"check_regions":["WEU","ENAM"],"type":"HTTPS","consecutive_successes":1,"consecutive_fails":1,"http_config":{"method":"GET","port":80,"path":"/health","expected_codes":["2xx","302"],"expected_body":"success","follow_redirects":false,"allow_insecure":false,"header":{"Host":["example.com"],"X-App-ID":["abc123"]}},"tcp_config":{"method":"connection_established","port":80},"timeout":5,"retries":2,"interval":60,"address":"www.example.com"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "server-1",
    "description": "Health check for www.example.com",
    "suspended": false,
    "notification": {
      "suspended": false,
      "email_addresses": [
        "alert@example.com",
        "oncall@example.com"
      ],
      "trigger": "FAIL"
    },
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "type": "HTTPS",
    "consecutive_successes": 1,
    "consecutive_fails": 1,
    "http_config": {
      "method": "GET",
      "port": 80,
      "path": "/health",
      "expected_codes": [
        "2xx",
        "302"
      ],
      "expected_body": "success",
      "follow_redirects": false,
      "allow_insecure": false,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      }
    },
    "tcp_config": {
      "method": "connection_established",
      "port": 80
    },
    "timeout": 5,
    "retries": 2,
    "interval": 60,
    "address": "www.example.com",
    "status": "healthy",
    "failure_reason": ""
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                health-checks-health-check-preview-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET Health Check Preview Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Fetch a single configured health check preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                GET zones/:zone_identifier/healthchecks/preview/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/preview/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "server-1",
    "description": "Health check for www.example.com",
    "suspended": false,
    "notification": {
      "suspended": false,
      "email_addresses": [
        "alert@example.com",
        "oncall@example.com"
      ],
      "trigger": "FAIL"
    },
    "check_regions": [
      "WEU",
      "ENAM"
    ],
    "type": "HTTPS",
    "consecutive_successes": 1,
    "consecutive_fails": 1,
    "http_config": {
      "method": "GET",
      "port": 80,
      "path": "/health",
      "expected_codes": [
        "2xx",
        "302"
      ],
      "expected_body": "success",
      "follow_redirects": false,
      "allow_insecure": false,
      "header": {
        "Host": [
          "example.com"
        ],
        "X-App-ID": [
          "abc123"
        ]
      }
    },
    "tcp_config": {
      "method": "connection_established",
      "port": 80
    },
    "timeout": 5,
    "retries": 2,
    "interval": 60,
    "address": "www.example.com",
    "status": "healthy",
    "failure_reason": ""
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                health-checks-delete-preview-health-check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete Preview Health Check 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete a health check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE zones/:zone_identifier/healthchecks/preview/:identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/healthchecks/preview/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Diagnostics
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run diagnostics tools from Cloudflare's colos.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diagnostics
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diagnostics-traceroute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Traceroute 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Run traceroutes from Cloudflare's colos.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/diagnostics/traceroute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                targets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  "203.0.113.1",
  "cloudflare.com"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max length: 10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                colos
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If no source colo names specified, all colos will be used
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  "den01",
  "sin02"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "packets_per_ttl": 10,
  "packet_type": "icmp",
  "max_ttl": 5,
  "wait_time": 1,
  "port": 0
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/diagnostics/traceroute" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"targets":["203.0.113.1","cloudflare.com"],"colos":["den01","sin02"],"options":{"packets_per_ttl":10,"packet_type":"icmp","max_ttl":5,"wait_time":1,"port":0}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "target": "1.1.1.1",
      "colos": [
        {
          "error": "",
          "colo": {
            "name": "den01",
            "city": "Denver, CO, US"
          },
          "traceroute_time_ms": 969,
          "target_summary": {
            "asn": "",
            "ip": "1.1.1.1",
            "name": "1.1.1.1",
            "packet_count": 3,
            "mean_latency_ms": 0.021,
            "std_dev_latency_ms": 0.011269427669584647,
            "min_latency_ms": 0.014,
            "max_latency_ms": 0.034
          },
          "hops": [
            {
              "packets_ttl": 1,
              "packets_sent": 3,
              "packets_lost": 0,
              "nodes": [
                {
                  "asn": "AS13335",
                  "ip": "1.1.1.1",
                  "name": "one.one.one.one",
                  "packet_count": 3,
                  "mean_latency_ms": 0.021,
                  "std_dev_latency_ms": 0.011269427669584647,
                  "min_latency_ms": 0.014,
                  "max_latency_ms": 0.034
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Diagnostics error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1000Empty request body
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1001Invalid request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1002No targets were specified
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1003Could not gather all colos
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1004Target is not a valid address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1005Colo is not a valid colo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1006Invalid packet_type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1007Invalid ttl_end
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1008Invalid num_packets
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1009Invalid wait_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1010Account does not have permission
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1011Too many targets specified
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1012Invalid port
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Waiting Room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Zone-level waiting rooms
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    waiting-room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    waiting-room-list-waiting-rooms
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Waiting Rooms 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List waiting rooms
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET zones/:zone_identifier/waiting_rooms
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Number of items per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms?page=1&per_page=25" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "699d98642c564d2e855e9661899b7252",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "name": "production_webinar",
      "description": "Production - DO NOT MODIFY",
      "suspended": false,
      "host": "shop.example.com",
      "path": "/shop/checkout",
      "queue_all": true,
      "new_users_per_minute": 1000,
      "total_active_users": 1000,
      "session_duration": 10,
      "disable_session_renewal": false,
      "json_response_enabled": false,
      "queueing_method": "fifo",
      "cookie_attributes": {
        "samesite": "auto",
        "secure": "auto"
      },
      "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    waiting-room-create-waiting-room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create Waiting Room 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a new waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST zones/:zone_identifier/waiting_rooms
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Host name for which the waiting room will be applied (no wildcards). Please do not include the scheme(http:// or https://). The host and path combination must be unique.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "shop.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      total_active_users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The total number of active user sessions on the route at a point in time. A route is a combination of host and path on which waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "production_webinar"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new_users_per_minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "/shop/checkout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        custom_page_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Available only with the Waiting Rooms Advanced subscription. This a templated html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1. {{waitTimeKnown}} This acts like a boolean value which tells us the behavior to take when wait time isn't available such as when queue_all is true. 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. {{waitTimeFormatted}} This is the estimated wait time for the user (example value: 5 minutes). Alternatively, you can use: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. {{waitTime}} This value specifies the number of minutes of wait time estimated for this user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. {{queueIsFull}} Changes to True when no more people can be added to the queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        queueing_method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The queueing method used by the waiting room. Changing this from the default queueing method is available only with the Waiting Rooms Advanced subscription. Regardless of the queueing method, if queue_all is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1. fifo (default): First-In-First-Out queue where customers gain access in the order they arrived.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. random: Random queue where customers gain access randomly, regardless of arrival time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. passthrough: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with suspended) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. reject: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses reject, and its events override this with fifo, random, or passthrough. When this queueing method is enabled and neither queueAll is enabled nor an event is prequeueing, the waiting room page will not refresh automatically.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "fifo"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: fifo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: fifo, random, passthrough, reject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cookie_attributes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Configure cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "samesite": "auto",
  "secure": "auto"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          queue_all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If queue_all is true all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          disable_session_renewal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Available only with the Waiting Rooms Advanced subscription. Disables automatic renewal of session cookies. If true, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If false, a user's session cookie will be automatically renewed on every request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          json_response_enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Available only with the Waiting Rooms Advanced subscription. If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property cfWaitingRoom which is an object containing the following fields:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          1. inWaitingRoom: Boolean indicating if the user is in the waiting room (always true).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. waitTimeKnown: Boolean indicating if the current estimated wait times are accurate. If false, they are not available.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. waitTime: Valid only when waitTimeKnown is true. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When queueingMethod is random, this is set to waitTime50Percentile.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          4. waitTime25Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5. waitTime50Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before waitTime50Percentile and half are expected to be let in after it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            6. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          6. waitTime75Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            7. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          7. waitTimeFormatted: String displaying the waitTime formatted in English for users. If waitTimeKnown is false, waitTimeFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            8. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          8. queueIsFull: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            9. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          9. queueAll: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10. lastUpdated: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after refreshIntervalSeconds past this time. If the user makes a request too soon, it will be ignored and lastUpdated will not change.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            11. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          11. refreshIntervalSeconds: Integer indicating the number of seconds after lastUpdated until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the queueingMethod is reject, there is no specified refresh time — it will always be 0.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            12. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          12. queueingMethod: The queueing method currently used by the waiting room. It is either fifo, random, passthrough, or reject.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            13. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          13. isFIFOQueue: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            14. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          14. isRandomQueue: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            15. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          15. isPassthroughQueue: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when queueAll is true or isEventPrequeueing is true because in all other cases requests will go directly to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            16. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          16. isRejectQueue: Boolean indicating if the waiting room uses a reject queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            17. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          17. isEventActive: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties prequeue_start_time, event_start_time, and event_end_time in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            18. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          18. isEventPrequeueing: Valid only when isEventActive is true. Boolean indicating if an event is currently prequeueing users before it starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            19. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          19. timeUntilEventStart: Valid only when isEventPrequeueing is true. Integer indicating the number of minutes until the event starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            20. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          20. timeUntilEventStartFormatted: String displaying the timeUntilEventStart formatted in English for users. If isEventPrequeueing is false, timeUntilEventStartFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            21. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          21. timeUntilEventEnd: Valid only when isEventActive is true. Integer indicating the number of minutes until the event ends.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            22. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          22. timeUntilEventEndFormatted: String displaying the timeUntilEventEnd formatted in English for users. If isEventActive is false, timeUntilEventEndFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            23. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          23. shuffleAtEventStart: Valid only when isEventActive is true. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            24. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An example cURL to a waiting room could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://example.com/waitingroom" \
    -H "Accept: application/json"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If json_response_enabled is true and the request hits the waiting room, an example JSON response when queueingMethod is fifo and no event is active could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
    "cfWaitingRoom": {
        "inWaitingRoom": true,
        "waitTimeKnown": true,
        "waitTime": 10,
        "waitTime25Percentile": 0,
        "waitTime50Percentile": 0,
        "waitTime75Percentile": 0,
        "waitTimeFormatted": "10 minutes",
        "queueIsFull": false,
        "queueAll": false,
        "lastUpdated": "2020-08-03T23:46:00.000Z",
        "refreshIntervalSeconds": 20,
        "queueingMethod": "fifo",
        "isFIFOQueue": true,
        "isRandomQueue": false,
        "isPassthroughQueue": false,
        "isRejectQueue": false,
        "isEventActive": false,
        "isEventPrequeueing": false,
        "timeUntilEventStart": 0,
        "timeUntilEventStartFormatted": "unavailable",
        "timeUntilEventEnd": 0,
        "timeUntilEventEndFormatted": "unavailable",
        "shuffleAtEventStart": false
    }
}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If json_response_enabled is true and the request hits the waiting room, an example JSON response when queueingMethod is random and an event is active could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
    "cfWaitingRoom": {
        "inWaitingRoom": true,
        "waitTimeKnown": true,
        "waitTime": 10,
        "waitTime25Percentile": 5,
        "waitTime50Percentile": 10,
        "waitTime75Percentile": 15,
        "waitTimeFormatted": "5 minutes to 15 minutes",
        "queueIsFull": false,
        "queueAll": false,
        "lastUpdated": "2020-08-03T23:46:00.000Z",
        "refreshIntervalSeconds": 20,
        "queueingMethod": "random",
        "isFIFOQueue": false,
        "isRandomQueue": true,
        "isPassthroughQueue": false,
        "isRejectQueue": false,
        "isEventActive": true,
        "isEventPrequeueing": false,
        "timeUntilEventStart": 0,
        "timeUntilEventStartFormatted": "unavailable",
        "timeUntilEventEnd": 15,
        "timeUntilEventEndFormatted": "15 minutes",
        "shuffleAtEventStart": true
    }
}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If suspended, the traffic doesn't go to the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A description to let users add more details about the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Production - DO NOT MODIFY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • max value:30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"production_webinar","description":"Production - DO NOT MODIFY","suspended":false,"host":"shop.example.com","path":"/shop/checkout","queue_all":true,"new_users_per_minute":1000,"total_active_users":1000,"session_duration":10,"disable_session_renewal":false,"json_response_enabled":false,"queueing_method":"fifo","cookie_attributes":{"samesite":"auto","secure":"auto"},"custom_page_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar",
    "description": "Production - DO NOT MODIFY",
    "suspended": false,
    "host": "shop.example.com",
    "path": "/shop/checkout",
    "queue_all": true,
    "new_users_per_minute": 1000,
    "total_active_users": 1000,
    "session_duration": 10,
    "disable_session_renewal": false,
    "json_response_enabled": false,
    "queueing_method": "fifo",
    "cookie_attributes": {
      "samesite": "auto",
      "secure": "auto"
    },
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          waiting-room-waiting-room-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Waiting Room Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fetch a single configured waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET zones/:zone_identifier/waiting_rooms/:waiting_room_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar",
    "description": "Production - DO NOT MODIFY",
    "suspended": false,
    "host": "shop.example.com",
    "path": "/shop/checkout",
    "queue_all": true,
    "new_users_per_minute": 1000,
    "total_active_users": 1000,
    "session_duration": 10,
    "disable_session_renewal": false,
    "json_response_enabled": false,
    "queueing_method": "fifo",
    "cookie_attributes": {
      "samesite": "auto",
      "secure": "auto"
    },
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          waiting-room-update-waiting-room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update Waiting Room 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Update a configured waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT zones/:zone_identifier/waiting_rooms/:waiting_room_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Host name for which the waiting room will be applied (no wildcards). Please do not include the scheme(http:// or https://). The host and path combination must be unique.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "shop.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            total_active_users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The total number of active user sessions on the route at a point in time. A route is a combination of host and path on which waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "production_webinar"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              new_users_per_minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "/shop/checkout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              custom_page_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Available only with the Waiting Rooms Advanced subscription. This a templated html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              1. {{waitTimeKnown}} This acts like a boolean value which tells us the behavior to take when wait time isn't available such as when queue_all is true. 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2. {{waitTimeFormatted}} This is the estimated wait time for the user (example value: 5 minutes). Alternatively, you can use: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              3. {{waitTime}} This value specifies the number of minutes of wait time estimated for this user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              4. {{queueIsFull}} Changes to True when no more people can be added to the queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              queueing_method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The queueing method used by the waiting room. Changing this from the default queueing method is available only with the Waiting Rooms Advanced subscription. Regardless of the queueing method, if queue_all is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              1. fifo (default): First-In-First-Out queue where customers gain access in the order they arrived.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              2. random: Random queue where customers gain access randomly, regardless of arrival time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              3. passthrough: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with suspended) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              4. reject: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses reject, and its events override this with fifo, random, or passthrough. When this queueing method is enabled and neither queueAll is enabled nor an event is prequeueing, the waiting room page will not refresh automatically.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "fifo"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: fifo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: fifo, random, passthrough, reject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cookie_attributes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Configure cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "samesite": "auto",
  "secure": "auto"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                queue_all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If queue_all is true all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                disable_session_renewal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Available only with the Waiting Rooms Advanced subscription. Disables automatic renewal of session cookies. If true, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If false, a user's session cookie will be automatically renewed on every request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                json_response_enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Available only with the Waiting Rooms Advanced subscription. If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property cfWaitingRoom which is an object containing the following fields:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                1. inWaitingRoom: Boolean indicating if the user is in the waiting room (always true).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                2. waitTimeKnown: Boolean indicating if the current estimated wait times are accurate. If false, they are not available.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                3. waitTime: Valid only when waitTimeKnown is true. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When queueingMethod is random, this is set to waitTime50Percentile.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                4. waitTime25Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                5. waitTime50Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before waitTime50Percentile and half are expected to be let in after it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  6. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                6. waitTime75Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  7. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                7. waitTimeFormatted: String displaying the waitTime formatted in English for users. If waitTimeKnown is false, waitTimeFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  8. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                8. queueIsFull: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  9. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                9. queueAll: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  10. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                10. lastUpdated: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after refreshIntervalSeconds past this time. If the user makes a request too soon, it will be ignored and lastUpdated will not change.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  11. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                11. refreshIntervalSeconds: Integer indicating the number of seconds after lastUpdated until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the queueingMethod is reject, there is no specified refresh time — it will always be 0.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  12. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                12. queueingMethod: The queueing method currently used by the waiting room. It is either fifo, random, passthrough, or reject.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  13. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                13. isFIFOQueue: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  14. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                14. isRandomQueue: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  15. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                15. isPassthroughQueue: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when queueAll is true or isEventPrequeueing is true because in all other cases requests will go directly to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  16. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                16. isRejectQueue: Boolean indicating if the waiting room uses a reject queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  17. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                17. isEventActive: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties prequeue_start_time, event_start_time, and event_end_time in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  18. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                18. isEventPrequeueing: Valid only when isEventActive is true. Boolean indicating if an event is currently prequeueing users before it starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  19. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                19. timeUntilEventStart: Valid only when isEventPrequeueing is true. Integer indicating the number of minutes until the event starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  20. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                20. timeUntilEventStartFormatted: String displaying the timeUntilEventStart formatted in English for users. If isEventPrequeueing is false, timeUntilEventStartFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  21. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                21. timeUntilEventEnd: Valid only when isEventActive is true. Integer indicating the number of minutes until the event ends.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  22. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                22. timeUntilEventEndFormatted: String displaying the timeUntilEventEnd formatted in English for users. If isEventActive is false, timeUntilEventEndFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  23. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                23. shuffleAtEventStart: Valid only when isEventActive is true. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  24. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An example cURL to a waiting room could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://example.com/waitingroom" \
    -H "Accept: application/json"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If json_response_enabled is true and the request hits the waiting room, an example JSON response when queueingMethod is fifo and no event is active could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
    "cfWaitingRoom": {
        "inWaitingRoom": true,
        "waitTimeKnown": true,
        "waitTime": 10,
        "waitTime25Percentile": 0,
        "waitTime50Percentile": 0,
        "waitTime75Percentile": 0,
        "waitTimeFormatted": "10 minutes",
        "queueIsFull": false,
        "queueAll": false,
        "lastUpdated": "2020-08-03T23:46:00.000Z",
        "refreshIntervalSeconds": 20,
        "queueingMethod": "fifo",
        "isFIFOQueue": true,
        "isRandomQueue": false,
        "isPassthroughQueue": false,
        "isRejectQueue": false,
        "isEventActive": false,
        "isEventPrequeueing": false,
        "timeUntilEventStart": 0,
        "timeUntilEventStartFormatted": "unavailable",
        "timeUntilEventEnd": 0,
        "timeUntilEventEndFormatted": "unavailable",
        "shuffleAtEventStart": false
    }
}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If json_response_enabled is true and the request hits the waiting room, an example JSON response when queueingMethod is random and an event is active could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
    "cfWaitingRoom": {
        "inWaitingRoom": true,
        "waitTimeKnown": true,
        "waitTime": 10,
        "waitTime25Percentile": 5,
        "waitTime50Percentile": 10,
        "waitTime75Percentile": 15,
        "waitTimeFormatted": "5 minutes to 15 minutes",
        "queueIsFull": false,
        "queueAll": false,
        "lastUpdated": "2020-08-03T23:46:00.000Z",
        "refreshIntervalSeconds": 20,
        "queueingMethod": "random",
        "isFIFOQueue": false,
        "isRandomQueue": true,
        "isPassthroughQueue": false,
        "isRejectQueue": false,
        "isEventActive": true,
        "isEventPrequeueing": false,
        "timeUntilEventStart": 0,
        "timeUntilEventStartFormatted": "unavailable",
        "timeUntilEventEnd": 15,
        "timeUntilEventEndFormatted": "15 minutes",
        "shuffleAtEventStart": true
    }
}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                If suspended, the traffic doesn't go to the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A description to let users add more details about the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Production - DO NOT MODIFY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • max value:30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"production_webinar","description":"Production - DO NOT MODIFY","suspended":false,"host":"shop.example.com","path":"/shop/checkout","queue_all":true,"new_users_per_minute":1000,"total_active_users":1000,"session_duration":10,"disable_session_renewal":false,"json_response_enabled":false,"queueing_method":"fifo","cookie_attributes":{"samesite":"auto","secure":"auto"},"custom_page_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar",
    "description": "Production - DO NOT MODIFY",
    "suspended": false,
    "host": "shop.example.com",
    "path": "/shop/checkout",
    "queue_all": true,
    "new_users_per_minute": 1000,
    "total_active_users": 1000,
    "session_duration": 10,
    "disable_session_renewal": false,
    "json_response_enabled": false,
    "queueing_method": "fifo",
    "cookie_attributes": {
      "samesite": "auto",
      "secure": "auto"
    },
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                waiting-room-patch-waiting-room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH Patch Waiting Room 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Patch a configured waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PATCH zones/:zone_identifier/waiting_rooms/:waiting_room_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Host name for which the waiting room will be applied (no wildcards). Please do not include the scheme(http:// or https://). The host and path combination must be unique.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "shop.example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  total_active_users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The total number of active user sessions on the route at a point in time. A route is a combination of host and path on which waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "production_webinar"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    new_users_per_minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "/shop/checkout"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: /
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    custom_page_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Available only with the Waiting Rooms Advanced subscription. This a templated html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1. {{waitTimeKnown}} This acts like a boolean value which tells us the behavior to take when wait time isn't available such as when queue_all is true. 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    2. {{waitTimeFormatted}} This is the estimated wait time for the user (example value: 5 minutes). Alternatively, you can use: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    3. {{waitTime}} This value specifies the number of minutes of wait time estimated for this user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    4. {{queueIsFull}} Changes to True when no more people can be added to the queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    queueing_method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The queueing method used by the waiting room. Changing this from the default queueing method is available only with the Waiting Rooms Advanced subscription. Regardless of the queueing method, if queue_all is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1. fifo (default): First-In-First-Out queue where customers gain access in the order they arrived.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    2. random: Random queue where customers gain access randomly, regardless of arrival time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    3. passthrough: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with suspended) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    4. reject: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses reject, and its events override this with fifo, random, or passthrough. When this queueing method is enabled and neither queueAll is enabled nor an event is prequeueing, the waiting room page will not refresh automatically.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "fifo"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • default value: fifo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • valid values: fifo, random, passthrough, reject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cookie_attributes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Configure cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "samesite": "auto",
  "secure": "auto"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      queue_all
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If queue_all is true all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disable_session_renewal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Available only with the Waiting Rooms Advanced subscription. Disables automatic renewal of session cookies. If true, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If false, a user's session cookie will be automatically renewed on every request.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      json_response_enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Available only with the Waiting Rooms Advanced subscription. If true, requests to the waiting room with the header Accept: application/json will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property cfWaitingRoom which is an object containing the following fields:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      1. inWaitingRoom: Boolean indicating if the user is in the waiting room (always true).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      2. waitTimeKnown: Boolean indicating if the current estimated wait times are accurate. If false, they are not available.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      3. waitTime: Valid only when waitTimeKnown is true. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When queueingMethod is random, this is set to waitTime50Percentile.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      4. waitTime25Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      5. waitTime50Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before waitTime50Percentile and half are expected to be let in after it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        6. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      6. waitTime75Percentile: Valid only when queueingMethod is random and waitTimeKnown is true. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        7. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      7. waitTimeFormatted: String displaying the waitTime formatted in English for users. If waitTimeKnown is false, waitTimeFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        8. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      8. queueIsFull: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        9. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      9. queueAll: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        10. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      10. lastUpdated: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after refreshIntervalSeconds past this time. If the user makes a request too soon, it will be ignored and lastUpdated will not change.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        11. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      11. refreshIntervalSeconds: Integer indicating the number of seconds after lastUpdated until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the queueingMethod is reject, there is no specified refresh time — it will always be 0.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        12. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      12. queueingMethod: The queueing method currently used by the waiting room. It is either fifo, random, passthrough, or reject.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        13. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      13. isFIFOQueue: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        14. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      14. isRandomQueue: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        15. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      15. isPassthroughQueue: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when queueAll is true or isEventPrequeueing is true because in all other cases requests will go directly to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        16. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      16. isRejectQueue: Boolean indicating if the waiting room uses a reject queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        17. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      17. isEventActive: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties prequeue_start_time, event_start_time, and event_end_time in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        18. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      18. isEventPrequeueing: Valid only when isEventActive is true. Boolean indicating if an event is currently prequeueing users before it starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        19. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      19. timeUntilEventStart: Valid only when isEventPrequeueing is true. Integer indicating the number of minutes until the event starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        20. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      20. timeUntilEventStartFormatted: String displaying the timeUntilEventStart formatted in English for users. If isEventPrequeueing is false, timeUntilEventStartFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        21. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      21. timeUntilEventEnd: Valid only when isEventActive is true. Integer indicating the number of minutes until the event ends.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        22. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      22. timeUntilEventEndFormatted: String displaying the timeUntilEventEnd formatted in English for users. If isEventActive is false, timeUntilEventEndFormatted will display "unavailable".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        23. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      23. shuffleAtEventStart: Valid only when isEventActive is true. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        24. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      An example cURL to a waiting room could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://example.com/waitingroom" \
    -H "Accept: application/json"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If json_response_enabled is true and the request hits the waiting room, an example JSON response when queueingMethod is fifo and no event is active could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
    "cfWaitingRoom": {
        "inWaitingRoom": true,
        "waitTimeKnown": true,
        "waitTime": 10,
        "waitTime25Percentile": 0,
        "waitTime50Percentile": 0,
        "waitTime75Percentile": 0,
        "waitTimeFormatted": "10 minutes",
        "queueIsFull": false,
        "queueAll": false,
        "lastUpdated": "2020-08-03T23:46:00.000Z",
        "refreshIntervalSeconds": 20,
        "queueingMethod": "fifo",
        "isFIFOQueue": true,
        "isRandomQueue": false,
        "isPassthroughQueue": false,
        "isRejectQueue": false,
        "isEventActive": false,
        "isEventPrequeueing": false,
        "timeUntilEventStart": 0,
        "timeUntilEventStartFormatted": "unavailable",
        "timeUntilEventEnd": 0,
        "timeUntilEventEndFormatted": "unavailable",
        "shuffleAtEventStart": false
    }
}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If json_response_enabled is true and the request hits the waiting room, an example JSON response when queueingMethod is random and an event is active could be:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
    "cfWaitingRoom": {
        "inWaitingRoom": true,
        "waitTimeKnown": true,
        "waitTime": 10,
        "waitTime25Percentile": 5,
        "waitTime50Percentile": 10,
        "waitTime75Percentile": 15,
        "waitTimeFormatted": "5 minutes to 15 minutes",
        "queueIsFull": false,
        "queueAll": false,
        "lastUpdated": "2020-08-03T23:46:00.000Z",
        "refreshIntervalSeconds": 20,
        "queueingMethod": "random",
        "isFIFOQueue": false,
        "isRandomQueue": true,
        "isPassthroughQueue": false,
        "isRejectQueue": false,
        "isEventActive": true,
        "isEventPrequeueing": false,
        "timeUntilEventStart": 0,
        "timeUntilEventStartFormatted": "unavailable",
        "timeUntilEventEnd": 15,
        "timeUntilEventEndFormatted": "15 minutes",
        "shuffleAtEventStart": true
    }
}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If suspended, the traffic doesn't go to the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A description to let users add more details about the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "Production - DO NOT MODIFY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max value:30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X PATCH "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"production_webinar","description":"Production - DO NOT MODIFY","suspended":false,"host":"shop.example.com","path":"/shop/checkout","queue_all":true,"new_users_per_minute":1000,"total_active_users":1000,"session_duration":10,"disable_session_renewal":false,"json_response_enabled":false,"queueing_method":"fifo","cookie_attributes":{"samesite":"auto","secure":"auto"},"custom_page_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar",
    "description": "Production - DO NOT MODIFY",
    "suspended": false,
    "host": "shop.example.com",
    "path": "/shop/checkout",
    "queue_all": true,
    "new_users_per_minute": 1000,
    "total_active_users": 1000,
    "session_duration": 10,
    "disable_session_renewal": false,
    "json_response_enabled": false,
    "queueing_method": "fifo",
    "cookie_attributes": {
      "samesite": "auto",
      "secure": "auto"
    },
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      waiting-room-delete-waiting-room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE Delete Waiting Room 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Delete a waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DELETE zones/:zone_identifier/waiting_rooms/:waiting_room_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "699d98642c564d2e855e9661899b7252"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      waiting-room-list-events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET List Events 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      List events for a waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET zones/:zone_identifier/waiting_rooms/:waiting_room_id/events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Page number of paginated results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Number of items per page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • default value: 25
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • min value:5
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • max value:1000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events?page=1&per_page=25" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "25756b2dfe6e378a06b033b670413757",
      "created_on": "2014-01-01T05:20:00.12345Z",
      "modified_on": "2014-01-01T05:20:00.12345Z",
      "name": "production_webinar_event",
      "description": "Production event - DO NOT MODIFY",
      "suspended": false,
      "prequeue_start_time": "2021-09-28T15:00:00.000Z",
      "event_start_time": "2021-09-28T15:30:00.000Z",
      "event_end_time": "2021-09-28T17:00:00.000Z",
      "shuffle_at_event_start": false,
      "new_users_per_minute": 2000,
      "total_active_users": 2500,
      "session_duration": null,
      "disable_session_renewal": null,
      "queueing_method": "random",
      "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      waiting-room-create-event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST Create Event 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Available only with the Waiting Rooms Advanced subscription. Create an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST zones/:zone_identifier/waiting_rooms/:waiting_room_id/events
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "production_webinar_event"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        event_start_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. Must occur at least 1 minute before event_end_time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "2021-09-28T15:30:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          event_end_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ISO 8601 timestamp that marks the end of the event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "2021-09-28T17:00:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            total_active_users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            new_users_per_minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            custom_page_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            queueing_method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "random"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            shuffle_at_event_start
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            disable_session_renewal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            booleannull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            prequeue_start_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ISO 8601 timestamp that marks when to begin queueing all users before the event starts. Must occur at least 5 minutes before event_start_time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "2021-09-28T15:00:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A description to let users add more details about the event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Production event - DO NOT MODIFY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max value:30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"production_webinar_event","description":"Production event - DO NOT MODIFY","suspended":false,"prequeue_start_time":"2021-09-28T15:00:00.000Z","event_start_time":"2021-09-28T15:30:00.000Z","event_end_time":"2021-09-28T17:00:00.000Z","shuffle_at_event_start":false,"new_users_per_minute":2000,"total_active_users":2500,"session_duration":null,"disable_session_renewal":null,"queueing_method":"random","custom_page_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "description": "Production event - DO NOT MODIFY",
    "suspended": false,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "shuffle_at_event_start": false,
    "new_users_per_minute": 2000,
    "total_active_users": 2500,
    "session_duration": null,
    "disable_session_renewal": null,
    "queueing_method": "random",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            waiting-room-event-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET Event Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Fetch a single configured event for a waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events/25756b2dfe6e378a06b033b670413757" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "description": "Production event - DO NOT MODIFY",
    "suspended": false,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "shuffle_at_event_start": false,
    "new_users_per_minute": 2000,
    "total_active_users": 2500,
    "session_duration": null,
    "disable_session_renewal": null,
    "queueing_method": "random",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            waiting-room-update-event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT Update Event 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update a configured event for a waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PUT zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "production_webinar_event"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              event_start_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. Must occur at least 1 minute before event_end_time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "2021-09-28T15:30:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                event_end_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ISO 8601 timestamp that marks the end of the event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "2021-09-28T17:00:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  total_active_users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  2500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  new_users_per_minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  2000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  custom_page_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  queueing_method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "random"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  shuffle_at_event_start
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disable_session_renewal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  booleannull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  prequeue_start_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ISO 8601 timestamp that marks when to begin queueing all users before the event starts. Must occur at least 5 minutes before event_start_time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2021-09-28T15:00:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A description to let users add more details about the event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "Production event - DO NOT MODIFY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • max value:30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events/25756b2dfe6e378a06b033b670413757" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"production_webinar_event","description":"Production event - DO NOT MODIFY","suspended":false,"prequeue_start_time":"2021-09-28T15:00:00.000Z","event_start_time":"2021-09-28T15:30:00.000Z","event_end_time":"2021-09-28T17:00:00.000Z","shuffle_at_event_start":false,"new_users_per_minute":2000,"total_active_users":2500,"session_duration":null,"disable_session_renewal":null,"queueing_method":"random","custom_page_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "description": "Production event - DO NOT MODIFY",
    "suspended": false,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "shuffle_at_event_start": false,
    "new_users_per_minute": 2000,
    "total_active_users": 2500,
    "session_duration": null,
    "disable_session_renewal": null,
    "queueing_method": "random",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  waiting-room-patch-event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Patch Event 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Patch a configured event for a waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "production_webinar_event"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    event_start_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. Must occur at least 1 minute before event_end_time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "2021-09-28T15:30:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      event_end_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ISO 8601 timestamp that marks the end of the event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "2021-09-28T17:00:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        total_active_users
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, the event will override the waiting room's total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event's new_users_per_minute property is also set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2500
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new_users_per_minute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, the event will override the waiting room's new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event's total_active_users property is also set.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2000
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • min value:200
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max value:2147483647
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        custom_page_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, the event will override the waiting room's custom_page_html property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        queueing_method
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, the event will override the waiting room's queueing_method property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "random"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        shuffle_at_event_start
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as fifo, or else the shuffling may be unnecessary.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        disable_session_renewal
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        booleannull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, the event will override the waiting room's disable_session_renewal property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prequeue_start_time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stringnull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ISO 8601 timestamp that marks when to begin queueing all users before the event starts. Must occur at least 5 minutes before event_start_time.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "2021-09-28T15:00:00.000Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        suspended
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If suspended, the event is ignored and traffic will be handled based on the waiting room configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A description to let users add more details about the event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "Production event - DO NOT MODIFY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        session_duration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integernull
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, the event will override the waiting room's session_duration property while it is active. If null, the event will inherit it.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: null
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • min value:1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • max value:30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X PATCH "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events/25756b2dfe6e378a06b033b670413757" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"production_webinar_event","description":"Production event - DO NOT MODIFY","suspended":false,"prequeue_start_time":"2021-09-28T15:00:00.000Z","event_start_time":"2021-09-28T15:30:00.000Z","event_end_time":"2021-09-28T17:00:00.000Z","shuffle_at_event_start":false,"new_users_per_minute":2000,"total_active_users":2500,"session_duration":null,"disable_session_renewal":null,"queueing_method":"random","custom_page_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "description": "Production event - DO NOT MODIFY",
    "suspended": false,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "shuffle_at_event_start": false,
    "new_users_per_minute": 2000,
    "total_active_users": 2500,
    "session_duration": null,
    "disable_session_renewal": null,
    "queueing_method": "random",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        waiting-room-delete-event
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE Delete Event 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Delete an event for a waiting room
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DELETE zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X DELETE "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events/25756b2dfe6e378a06b033b670413757" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        waiting-room-preview-active-event-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Preview Active Event Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preview an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id/details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/events/25756b2dfe6e378a06b033b670413757/details" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "25756b2dfe6e378a06b033b670413757",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "production_webinar_event",
    "description": "Production event - DO NOT MODIFY",
    "suspended": false,
    "prequeue_start_time": "2021-09-28T15:00:00.000Z",
    "event_start_time": "2021-09-28T15:30:00.000Z",
    "event_end_time": "2021-09-28T17:00:00.000Z",
    "shuffle_at_event_start": false,
    "new_users_per_minute": 2000,
    "total_active_users": 2500,
    "session_duration": 10,
    "disable_session_renewal": false,
    "queueing_method": "random",
    "custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        waiting-room-get-waiting-room-status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Get Waiting Room Status 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Fetch the status of a configured waiting room. Response fields include:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1. status: String indicating the status of the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • not_queueing indicates that the configured thresholds have not been met and all users are going through to the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • queueing indicates that the thresholds have been met and some users are held in the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • event_prequeueing indicates that an event is active and is currently prequeueing users before it starts.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. event_id: String of the current event's id if an event is active, otherwise an empty string.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. estimated_queued_users: Integer of the estimated number of users currently waiting in the queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. estimated_total_active_users: Integer of the estimated number of users currently active on the origin.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        5. max_estimated_time_minutes: Integer of the maximum estimated time currently presented to users.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          6. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET zones/:zone_identifier/waiting_rooms/:waiting_room_id/status
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/699d98642c564d2e855e9661899b7252/status" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "status": "queueing",
    "event_id": "25756b2dfe6e378a06b033b670413757",
    "estimated_queued_users": 10,
    "estimated_total_active_users": 9,
    "max_estimated_time_minutes": 5
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        waiting-room-create-a-custom-waiting-room-page-preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST Create a Custom Waiting Room Page Preview 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Upload a custom waiting room page for preview. You will receive a preview URL in the form http://waitingrooms.dev/preview/<uuid>. You can use the following query parameters to change the state of the preview:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1. force_queue: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. queue_is_full: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. queueing_method: The queueing method currently used by the waiting room.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • fifo indicates a FIFO queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • random indicates a Random queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • passthrough indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if force_queue=true or event=prequeueing — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning "Welcome". 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • reject indicates a Reject queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. event: Used to preview a waiting room event.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • none indicates no event is occurring.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • prequeueing indicates that an event is prequeueing (between prequeue_start_time and event_start_time).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • started indicates that an event has started (between event_start_time and event_end_time).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        5. shuffle_at_event_start: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to true if an event is active (event is not none).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          6. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        For example, you can make a request to http://waitingrooms.dev/preview/<uuid>?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1. waitTime: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        For example, you can make a request to http://waitingrooms.dev/preview/<uuid>?waitTime=50 to configure the estimated wait time as 50 minutes.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST zones/:zone_identifier/waiting_rooms/preview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        custom_html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Available only with the Waiting Rooms Advanced subscription. This a templated html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        1. {{waitTimeKnown}} This acts like a boolean value which tells us the behavior to take when wait time isn't available such as when queue_all is true. 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          2. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        2. {{waitTimeFormatted}} This is the estimated wait time for the user (example value: 5 minutes). Alternatively, you can use: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          3. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        3. {{waitTime}} This value specifies the number of minutes of wait time estimated for this user.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          4. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        4. {{queueIsFull}} Changes to True when no more people can be added to the queue.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          5. 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        To view the full list of variables, look at the cfWaitingRoom object described under the json_response_enabled property in other Waiting Room API calls.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • default value: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X POST "https://api.cloudflare.com/client/v4/zones/9a7806061c88ada191ed06f989cc3dac/waiting_rooms/preview" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"custom_html":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "preview_url": "http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Registrar Domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Manage Domains Names
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        registrar-domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        registrar-domains-list-domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST List Domains 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List domains handled by registrar
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        POST accounts/:account_identifier/registrar/domains
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        List of domain names
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [
  "cloudflare.com",
  "cloudflare.net"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/registrar/domains" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"id":["cloudflare.com","cloudflare.net"]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "ea95132c15732412d22c1476fa83f27a",
      "available": false,
      "supported_tld": true,
      "can_register": false,
      "transfer_in": {
        "unlock_domain": "ok",
        "disable_privacy": "ok",
        "enter_auth_code": "needed",
        "approve_transfer": "unknown",
        "accept_foa": "needed",
        "can_cancel_transfer": true
      },
      "current_registrar": "Cloudflare",
      "expires_at": "2019-08-28T23:59:59Z",
      "registry_statuses": "ok,serverTransferProhibited",
      "locked": false,
      "created_at": "2018-08-28T17:26:26Z",
      "updated_at": "2018-08-28T17:26:26Z",
      "registrant_contact": {
        "id": "ea95132c15732412d22c1476fa83f27a",
        "first_name": "John",
        "last_name": "Appleseed",
        "organization": "Cloudflare, Inc.",
        "address": "123 Sesame St.",
        "address2": "Suite 430",
        "city": "Austin",
        "state": "TX",
        "zip": "12345",
        "country": "US",
        "phone": "+1 123-123-1234",
        "email": "user@example.com",
        "fax": "123-867-5309"
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          registrar-domains-get-domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Get Domain 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show individual domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:account_identifier/registrar/domains/:domain_name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/registrar/domains/cloudflare.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ea95132c15732412d22c1476fa83f27a",
    "available": false,
    "supported_tld": true,
    "can_register": false,
    "transfer_in": {
      "unlock_domain": "ok",
      "disable_privacy": "ok",
      "enter_auth_code": "needed",
      "approve_transfer": "unknown",
      "accept_foa": "needed",
      "can_cancel_transfer": true
    },
    "current_registrar": "Cloudflare",
    "expires_at": "2019-08-28T23:59:59Z",
    "registry_statuses": "ok,serverTransferProhibited",
    "locked": false,
    "created_at": "2018-08-28T17:26:26Z",
    "updated_at": "2018-08-28T17:26:26Z",
    "registrant_contact": {
      "id": "ea95132c15732412d22c1476fa83f27a",
      "first_name": "John",
      "last_name": "Appleseed",
      "organization": "Cloudflare, Inc.",
      "address": "123 Sesame St.",
      "address2": "Suite 430",
      "city": "Austin",
      "state": "TX",
      "zip": "12345",
      "country": "US",
      "phone": "+1 123-123-1234",
      "email": "user@example.com",
      "fax": "123-867-5309"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          registrar-domains-update-domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update Domain 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Update individual domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT accounts/:account_identifier/registrar/domains/:domain_name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name_servers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          List of name servers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [
  "preston.ns.cloudflare.com",
  "oli.ns.cloudflare.com"
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            privacy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Privacy option controls redacting WHOIS information
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            locked
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether a registrar lock in place for this domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            false
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            auto_renew
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Auto-renew controls whether subscription is automatically renewed upon domain expiration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/registrar/domains/cloudflare.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name_servers":["preston.ns.cloudflare.com","oli.ns.cloudflare.com"],"privacy":true,"locked":false,"auto_renew":true}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "ea95132c15732412d22c1476fa83f27a",
    "available": false,
    "supported_tld": true,
    "can_register": false,
    "transfer_in": {
      "unlock_domain": "ok",
      "disable_privacy": "ok",
      "enter_auth_code": "needed",
      "approve_transfer": "unknown",
      "accept_foa": "needed",
      "can_cancel_transfer": true
    },
    "current_registrar": "Cloudflare",
    "expires_at": "2019-08-28T23:59:59Z",
    "registry_statuses": "ok,serverTransferProhibited",
    "locked": false,
    "created_at": "2018-08-28T17:26:26Z",
    "updated_at": "2018-08-28T17:26:26Z",
    "registrant_contact": {
      "id": "ea95132c15732412d22c1476fa83f27a",
      "first_name": "John",
      "last_name": "Appleseed",
      "organization": "Cloudflare, Inc.",
      "address": "123 Sesame St.",
      "address2": "Suite 430",
      "city": "Austin",
      "state": "TX",
      "zip": "12345",
      "country": "US",
      "phone": "+1 123-123-1234",
      "email": "user@example.com",
      "fax": "123-867-5309"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Registrar Domains error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10000Internal Server Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            10001Authentication Failure
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Argo Tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A tunnel that can route traffic to a user origin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            argo-tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            argo-tunnel-list-argo-tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET List Argo Tunnels 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            List, search and filter an account's Argo Tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GET accounts/:account_identifier/tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A user-friendly name chosen when the tunnel is created. Cannot be empty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "blog"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string (uuid)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UUID of the tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 36
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              is_deleted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If true, only include deleted tunnels. If false, exclude deleted tunnels. If not provided, all tunnels will be included
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              existed_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If provided, include only tunnels that were created before this time and not deleted at this time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "2019-10-12T07:20:50.52Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/tunnels?name=blog&uuid=f70ff985-a4ef-4643-bbbc-4a0ed4fc8415&is_deleted=true&existed_at=2019-10-12T07:20:50.52Z" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
      "name": "blog",
      "created_at": "2021-01-25T18:22:34.317854Z",
      "deleted_at": "2009-11-10T23:00:00Z",
      "connections": [
        {
          "colo_name": "DFW",
          "uuid": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
          "is_pending_reconnect": false
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                argo-tunnel-create-argo-tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST Create Argo Tunnel 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Create an Argo Tunnel in an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                POST accounts/:account_identifier/tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A user-friendly name chosen when the tunnel is created. Cannot be empty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "blog"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tunnel_secret
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  32 or more bytes, encoded as a base64 string. The Create Argo Tunnel endpoint sets this as the tunnel's password. Anyone wishing to run the tunnel needs this password
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg="
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/tunnels" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"blog","tunnel_secret":"AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg="}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "name": "blog",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00Z",
    "connections": [
      {
        "colo_name": "DFW",
        "uuid": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "is_pending_reconnect": false
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    argo-tunnel-get-argo-tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET Get Argo Tunnel 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the details of an Argo Tunnel from an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:account_identifier/tunnels/:tunnel_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/tunnels/f70ff985-a4ef-4643-bbbc-4a0ed4fc8415?" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "name": "blog",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00Z",
    "connections": [
      {
        "colo_name": "DFW",
        "uuid": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "is_pending_reconnect": false
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    argo-tunnel-delete-argo-tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Argo Tunnel 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete an Argo Tunnel from an account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:account_identifier/tunnels/:tunnel_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/tunnels/f70ff985-a4ef-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "name": "blog",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2009-11-10T23:00:00Z",
    "connections": [
      {
        "colo_name": "DFW",
        "uuid": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "is_pending_reconnect": false
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    argo-tunnel-clean-up-argo-tunnel-connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Clean Up Argo Tunnel Connections 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Remove stale connection resources from an Argo Tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:account_identifier/tunnels/:tunnel_id/connections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/tunnels/f70ff985-a4ef-4643-bbbc-4a0ed4fc8415/connections" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tunnel Route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    A network address range that the Tunnel connects.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tunnel-route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tunnel-route-list-tunnel-routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List Tunnel Routes 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    List, search and filter an account's tunnel routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:account_identifier/routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tunnel_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string (uuid)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UUID of the tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • max length: 36
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    comment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional remark describing the route. Empty if none
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Example comment for this route"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      is_deleted
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If true, only include deleted routes. If false, exclude deleted routes. If not provided, all routes will be included
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      network_subset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      If set, only list routes that are a subset of this network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "ff01::/32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        network_superset
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        If set, only list routes that are a superset of this network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "ff01::/32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          existed_at
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string (date-time)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          If provided, include only routes that were created before this time and not deleted at this time
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "2019-10-12T07:20:50.52Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/routes?tunnel_id=f70ff985-a4ef-4643-bbbc-4a0ed4fc8415&comment=Example comment for this route&is_deleted=true&network_subset=ff01::/32&network_superset=ff01::/32&existed_at=2019-10-12T07:20:50.52Z" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "network": "ff01::/32",
      "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
      "tunnel_name": "blog",
      "comment": "Example comment for this route",
      "created_at": "2021-01-25T18:22:34.317854Z",
      "deleted_at": "2021-01-25T18:22:34.317854Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tunnel-route-create-route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST Create Route 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Add a new route to the account's routing table for the given tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            POST accounts/:account_identifier/routes/network/:ip_network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tunnel_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string (uuid)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            UUID of the tunnel for which this route is being added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • max length: 36
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            comment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional remark describing the route. Empty if none
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Example comment for this route"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/routes/network/ff01::/32" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"tunnel_id":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","comment":"Example comment for this route"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "network": "ff01::/32",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "blog",
    "comment": "Example comment for this route",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2021-01-25T18:22:34.317854Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tunnel-route-update-route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH Update Route 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Update an existing route in the account's routing table for the given tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PATCH accounts/:account_identifier/routes/network/:ip_network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tunnel_id
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string (uuid)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UUID of the tunnel this route should belong to
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • max length: 36
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • read only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              comment
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional remark describing the route. Empty if none
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "Example comment for this route"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                New CIDR of this route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "ff01::/32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/routes/network/ff01::/32" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"tunnel_id":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","comment":"Example comment for this route","network":"ff01::/32"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "network": "ff01::/32",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "blog",
    "comment": "Example comment for this route",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2021-01-25T18:22:34.317854Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tunnel-route-delete-route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH Delete Route 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Delete an existing route from the account's routing table
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PATCH accounts/:account_identifier/routes/network/:ip_network
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PATCH "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/routes/network/ff01::/32" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "network": "ff01::/32",
    "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
    "tunnel_name": "blog",
    "comment": "Example comment for this route",
    "created_at": "2021-01-25T18:22:34.317854Z",
    "deleted_at": "2021-01-25T18:22:34.317854Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Magic Transit Static Routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Used to route traffic through GRE tunnels for Magic Transit.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-transit-static-routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-transit-static-routes-list-routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List Routes 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List static routes associated with an account's Magic Transit setup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/magic/routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/routes" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "routes": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "created_on": "2017-06-14T00:00:00Z",
        "modified_on": "2017-06-14T05:20:00Z",
        "prefix": "192.0.2.0/24",
        "nexthop": "203.0.113.1",
        "priority": 100,
        "description": "New route for new prefix 203.0.113.1",
        "weight": 100,
        "scope": {
          "colo_regions": [
            "APAC"
          ],
          "colo_names": [
            "den01"
          ]
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-transit-static-routes-route-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Route Details permission needed: #organization:read
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get a specific static route for an account's Magic Transit setup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/magic/routes/:route_identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/routes/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "route": {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z",
      "prefix": "192.0.2.0/24",
      "nexthop": "203.0.113.1",
      "priority": 100,
      "description": "New route for new prefix 203.0.113.1",
      "weight": 100,
      "scope": {
        "colo_regions": [
          "APAC"
        ],
        "colo_names": [
          "den01"
        ]
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-transit-static-routes-create-routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create Routes permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Creates a new static route associated with an account's Magic Transit setup. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST accounts/:account_identifier/magic/routes?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "prefix": "192.0.2.0/24",
    "nexthop": "203.0.113.1",
    "priority": 100,
    "description": "New route for new prefix 203.0.113.1",
    "weight": 100,
    "scope": {
      "colo_regions": [
        "APAC"
      ],
      "colo_names": [
        "den01"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/routes?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"routes":[{"prefix":"192.0.2.0/24","nexthop":"203.0.113.1","priority":100,"description":"New route for new prefix 203.0.113.1","weight":100,"scope":{"colo_regions":["APAC"],"colo_names":["den01"]}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "routes": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "created_on": "2017-06-14T00:00:00Z",
        "modified_on": "2017-06-14T05:20:00Z",
        "prefix": "192.0.2.0/24",
        "nexthop": "203.0.113.1",
        "priority": 100,
        "description": "New route for new prefix 203.0.113.1",
        "weight": 100,
        "scope": {
          "colo_regions": [
            "APAC"
          ],
          "colo_names": [
            "den01"
          ]
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    magic-transit-static-routes-update-route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update Route permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update a specific static route for an account's Magic Transit setup. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT accounts/:account_identifier/magic/routes/:route_identifier?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prefix
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IP Prefix in Classless Inter-Domain Routing format
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "192.0.2.0/24"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      nexthop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The next-hop IP Address for the static route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "203.0.113.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        priority
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Priority of the static route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          An optional human provided description of the static route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "New route for new prefix 203.0.113.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            weight
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Optional weight of the ECMP scope - if provided
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            100
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scope
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Used only for ECMP routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "colo_regions": [
    "APAC"
  ],
  "colo_names": [
    "den01"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/routes/01a7362d577a6c3019a474fd6f485823?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"prefix":"192.0.2.0/24","nexthop":"203.0.113.1","priority":100,"description":"New route for new prefix 203.0.113.1","weight":100,"scope":{"colo_regions":["APAC"],"colo_names":["den01"]}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "modified": true,
    "modified_route": {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z",
      "prefix": "192.0.2.0/24",
      "nexthop": "203.0.113.1",
      "priority": 100,
      "description": "New route for new prefix 203.0.113.1",
      "weight": 100,
      "scope": {
        "colo_regions": [
          "APAC"
        ],
        "colo_names": [
          "den01"
        ]
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                magic-transit-static-routes-update-many-routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT Update Many Routes permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update multiple static routes for an account's Magic Transit setup. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/magic/routes?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                routes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "prefix": "192.0.2.0/24",
    "nexthop": "203.0.113.1",
    "priority": 100,
    "description": "New route for new prefix 203.0.113.1",
    "weight": 100,
    "scope": {
      "colo_regions": [
        "APAC"
      ],
      "colo_names": [
        "den01"
      ]
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/routes?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"routes":[{"id":"01a7362d577a6c3019a474fd6f485823","prefix":"192.0.2.0/24","nexthop":"203.0.113.1","priority":100,"description":"New route for new prefix 203.0.113.1","weight":100,"scope":{"colo_regions":["APAC"],"colo_names":["den01"]}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "modified": true,
    "modified_routes": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "created_on": "2017-06-14T00:00:00Z",
        "modified_on": "2017-06-14T05:20:00Z",
        "prefix": "192.0.2.0/24",
        "nexthop": "203.0.113.1",
        "priority": 100,
        "description": "New route for new prefix 203.0.113.1",
        "weight": 100,
        "scope": {
          "colo_regions": [
            "APAC"
          ],
          "colo_names": [
            "den01"
          ]
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-transit-static-routes-delete-route
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete Route permission needed: #organization:edit
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Disable and remove a specific static route for an account's Magic Transit setup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE accounts/:account_identifier/magic/routes/:route_identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/routes/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "deleted": true,
    "deleted_route": {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z",
      "prefix": "192.0.2.0/24",
      "nexthop": "203.0.113.1",
      "priority": 100,
      "description": "New route for new prefix 203.0.113.1",
      "weight": 100,
      "scope": {
        "colo_regions": [
          "APAC"
        ],
        "colo_names": [
          "den01"
        ]
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Magic Transit Static Routes error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Magic GRE tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GRE tunnels that connect Cloudflare with your endpoints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-gre-tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-gre-tunnels-list-gre-tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET List GRE tunnels 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  List GRE tunnels associated with an account's Magic setup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/magic/gre_tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/gre_tunnels" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "gre_tunnels": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "created_on": "2017-06-14T00:00:00Z",
        "modified_on": "2017-06-14T05:20:00Z",
        "name": "GRE_1",
        "customer_gre_endpoint": "203.0.113.1",
        "cloudflare_gre_endpoint": "203.0.113.1",
        "interface_address": "192.0.2.0/31",
        "description": "Tunnel for ISP X",
        "ttl": 64,
        "mtu": 1476,
        "health_check": {
          "enabled": true,
          "target": "203.0.113.1",
          "type": "request"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-gre-tunnels-gre-tunnel-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET GRE Tunnel Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Get a specific GRE tunnel for an account's Magic setup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/magic/gre_tunnels/:tunnel_identifier
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/gre_tunnels/01a7362d577a6c3019a474fd6f485823" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "gre_tunnel": {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z",
      "name": "GRE_1",
      "customer_gre_endpoint": "203.0.113.1",
      "cloudflare_gre_endpoint": "203.0.113.1",
      "interface_address": "192.0.2.0/31",
      "description": "Tunnel for ISP X",
      "ttl": 64,
      "mtu": 1476,
      "health_check": {
        "enabled": true,
        "target": "203.0.113.1",
        "type": "request"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-gre-tunnels-create-gre-tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST Create GRE tunnels 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Creates new GRE tunnels associated with an account's Magic setup. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  POST accounts/:account_identifier/magic/gre_tunnels?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  gre_tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [
  {
    "name": "GRE_1",
    "customer_gre_endpoint": "203.0.113.1",
    "cloudflare_gre_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31",
    "description": "Tunnel for ISP X",
    "ttl": 64,
    "mtu": 1476,
    "health_check": {
      "enabled": true,
      "target": "203.0.113.1",
      "type": "request"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/gre_tunnels?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"gre_tunnels":[{"name":"GRE_1","customer_gre_endpoint":"203.0.113.1","cloudflare_gre_endpoint":"203.0.113.1","interface_address":"192.0.2.0/31","description":"Tunnel for ISP X","ttl":64,"mtu":1476,"health_check":{"enabled":true,"target":"203.0.113.1","type":"request"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "gre_tunnels": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "created_on": "2017-06-14T00:00:00Z",
        "modified_on": "2017-06-14T05:20:00Z",
        "name": "GRE_1",
        "customer_gre_endpoint": "203.0.113.1",
        "cloudflare_gre_endpoint": "203.0.113.1",
        "interface_address": "192.0.2.0/31",
        "description": "Tunnel for ISP X",
        "ttl": 64,
        "mtu": 1476,
        "health_check": {
          "enabled": true,
          "target": "203.0.113.1",
          "type": "request"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    magic-gre-tunnels-update-gre-tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update GRE Tunnel 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update a specific GRE tunnel for an account's Magic setup. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT accounts/:account_identifier/magic/gre_tunnels/:tunnel_identifier?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Should be a valid Linux interface name i.e has no spaces, special characters, is 15 or less characters, and doesn't share a name with other GRE tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "GRE_1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      customer_gre_endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The IP address assigned to the customer side of the GRE tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "203.0.113.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cloudflare_gre_endpoint
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The IP address assigned to the Cloudflare side of the GRE tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "203.0.113.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface_address
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          A 31-bit prefix (/31 in CIDR notation) supporting 2 hosts, one for each side of the GRE tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "192.0.2.0/31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            An optional description of the GRE tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "Tunnel for ISP X"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ttl
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Time To Live (TTL) in number of hops of the GRE tunnel. Minimum value 64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 64
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mtu
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              integer
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. Maximum value 1476 and minimum value 576
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              1476
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • default value: 1476
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              health_check
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "enabled": true,
  "target": "203.0.113.1",
  "type": "request"
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              An object with the following properties:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/gre_tunnels/01a7362d577a6c3019a474fd6f485823?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"GRE_1","customer_gre_endpoint":"203.0.113.1","cloudflare_gre_endpoint":"203.0.113.1","interface_address":"192.0.2.0/31","description":"Tunnel for ISP X","ttl":64,"mtu":1476,"health_check":{"enabled":true,"target":"203.0.113.1","type":"request"}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "modified": true,
    "modified_gre_tunnel": {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z",
      "name": "GRE_1",
      "customer_gre_endpoint": "203.0.113.1",
      "cloudflare_gre_endpoint": "203.0.113.1",
      "interface_address": "192.0.2.0/31",
      "description": "Tunnel for ISP X",
      "ttl": 64,
      "mtu": 1476,
      "health_check": {
        "enabled": true,
        "target": "203.0.113.1",
        "type": "request"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                magic-gre-tunnels-update-many-gre-tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT Update Many GRE tunnels 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Update many GRE tunnels for an account's Magic setup. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PUT accounts/:account_identifier/magic/gre_tunnels?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                gre_tunnels
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
  {
    "id": "01a7362d577a6c3019a474fd6f485823",
    "name": "GRE_1",
    "customer_gre_endpoint": "203.0.113.1",
    "cloudflare_gre_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31",
    "description": "Tunnel for ISP X",
    "ttl": 64,
    "mtu": 1476,
    "health_check": {
      "enabled": true,
      "target": "203.0.113.1",
      "type": "request"
    }
  }
]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An array with items in the following form:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X PUT "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/gre_tunnels?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"gre_tunnels":[{"id":"01a7362d577a6c3019a474fd6f485823","name":"GRE_1","customer_gre_endpoint":"203.0.113.1","cloudflare_gre_endpoint":"203.0.113.1","interface_address":"192.0.2.0/31","description":"Tunnel for ISP X","ttl":64,"mtu":1476,"health_check":{"enabled":true,"target":"203.0.113.1","type":"request"}}]}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "modified": true,
    "modified_gre_tunnels": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "created_on": "2017-06-14T00:00:00Z",
        "modified_on": "2017-06-14T05:20:00Z",
        "name": "GRE_1",
        "customer_gre_endpoint": "203.0.113.1",
        "cloudflare_gre_endpoint": "203.0.113.1",
        "interface_address": "192.0.2.0/31",
        "description": "Tunnel for ISP X",
        "ttl": 64,
        "mtu": 1476,
        "health_check": {
          "enabled": true,
          "target": "203.0.113.1",
          "type": "request"
        }
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  magic-gre-tunnels-delete-gre-tunnel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE Delete GRE Tunnel 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Disable and remove a specific static GRE Tunnel for an account's Magic setup.. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DELETE accounts/:account_identifier/magic/gre_tunnels/:tunnel_identifier?validate_only=:validate_only
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/magic/gre_tunnels/01a7362d577a6c3019a474fd6f485823?validate_only=true" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "deleted": true,
    "deleted_gre_tunnel": {
      "id": "c4a7362d577a6c3019a474fd6f485821",
      "created_on": "2017-06-14T00:00:00Z",
      "modified_on": "2017-06-14T05:20:00Z",
      "name": "GRE_1",
      "customer_gre_endpoint": "203.0.113.1",
      "cloudflare_gre_endpoint": "203.0.113.1",
      "interface_address": "192.0.2.0/31",
      "description": "Tunnel for ISP X",
      "ttl": 64,
      "mtu": 1476,
      "health_check": {
        "enabled": true,
        "target": "203.0.113.1",
        "type": "request"
      }
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Magic GRE tunnels error codes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CodeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Domain Intelligence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Domain overview (Beta)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  domain-intelligence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  domain-intelligence-get-domain-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET Get Domain Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GET accounts/:account_identifier/intel/domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "cloudflare.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/domain?domain=cloudflare.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "domain": "cloudflare.com",
    "resolves_to_refs": [
      {
        "id": "ipv4-addr--baa568ec-6efe-5902-be55-0663833db537",
        "value": "192.0.2.0"
      }
    ],
    "popularity_rank": 18,
    "application": {
      "id": 1370,
      "name": "CLOUDFLARE"
    },
    "risk_types": [],
    "content_categories": [
      {
        "id": 155,
        "super_category_id": 26,
        "name": "Technology"
      }
    ],
    "additional_information": {
      "suspected_malware_family": ""
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    domain-intelligence-get-multiple-domain-details
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET Get Multiple Domain Details 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:account_identifier/intel/domain/bulk
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accepts multiple values, i.e. ?domain=cloudflare.com&domain=example.com
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "cloudflare.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/domain/bulk?domain=cloudflare.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "domain": "cloudflare.com",
      "popularity_rank": 18,
      "application": {
        "id": 1370,
        "name": "CLOUDFLARE"
      },
      "risk_types": [],
      "content_categories": [
        {
          "id": 155,
          "super_category_id": 26,
          "name": "Technology"
        }
      ],
      "additional_information": {
        "suspected_malware_family": ""
      }
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Domain History
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Historical domain categorization (Beta)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      domain-history
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      domain-history-get-domain-history
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET Get Domain History 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      GET accounts/:account_identifier/intel/domain-history
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "example.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/domain-history?domain=example.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "domain": "cloudflare.com",
      "categorizations": [
        {
          "categories": [
            {
              "id": 155,
              "name": "Technology"
            }
          ],
          "start": "2021-04-01",
          "end": "2021-04-30"
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        WHOIS Record
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        WHOIS (Beta)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        whois-record
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        whois-record-get-whois-record
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Get WHOIS Record 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/intel/whois
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        domain
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cloudflare.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/whois?domain=cloudflare.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "domain": "cloudflare.com",
    "created_date": "2009-02-17",
    "updated_date": "2017-05-24",
    "registrant": "DATA REDACTED",
    "registrant_org": "DATA REDACTED",
    "registrant_country": "United States",
    "registrant_email": "https://domaincontact.cloudflareregistrar.com/cloudflare.com",
    "registrar": "Cloudflare, Inc.",
    "nameservers": [
      "ns3.cloudflare.com",
      "ns4.cloudflare.com",
      "ns5.cloudflare.com",
      "ns6.cloudflare.com",
      "ns7.cloudflare.com"
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IP Intelligence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          IP overview (Beta)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ip-intelligence
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ip-intelligence-get-ip-overview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Get IP Overview 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:account_identifier/intel/ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ipv4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string (ipv4)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "192.0.2.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ipv6
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string (ipv6)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "2001:0DB8::"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/ip?ipv4=192.0.2.0&ipv6=2001:0DB8::" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "ip": "192.0.2.0",
      "belongs_to_ref": {
        "id": "autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8",
        "value": 13335,
        "type": "hosting_provider",
        "country": "US",
        "description": "CLOUDFLARENET"
      },
      "risk_types": [
        {
          "id": 131,
          "super_category_id": 21,
          "name": "Phishing"
        }
      ]
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IP List
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              IP list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ip-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ip-list-get-ip-lists
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET Get IP Lists 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/intel/ip-list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/ip-list" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 3,
      "name": "Malware"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Passive DNS by IP
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Passive DNS by IP (Beta)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              passive-dns-by-ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              passive-dns-by-ip-get-passive-dns-by-ip
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET Get Passive DNS by IP 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GET accounts/:account_identifier/intel/dns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ipv4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string (ipv4)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "192.0.2.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                start
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string (date)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Defaults to 30 days before the end parameter value
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "2021-04-01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  end
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  string (date)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Defaults to the current date
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "2021-04-30"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Requested page within paginated list of results
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      per_page
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Maximum number of results requested
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel/dns?ipv4=192.0.2.0&start=2021-04-01&end=2021-04-30&page=1&per_page=20" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "reverse_records": [
      {
        "first_seen": "2021-04-01",
        "last_seen": "2021-04-30",
        "hostname": "cloudflare.com"
      }
    ],
    "count": 1,
    "page": 1,
    "per_page": 20
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Phishing URL Scanner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Phishing URL Scanner (Beta)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        phishing-url-scanner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        phishing-url-scanner-scan-suspicious-url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET Scan suspicious url 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GET accounts/:account_identifier/intel-phishing/predict
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string (url)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "https://www.cloudflare.com"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/01a7362d577a6c3019a474fd6f485823/intel-phishing/predict?url=https://www.cloudflare.com" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "url": "https://www.cloudflare.com",
    "phishing": false,
    "verified": false,
    "score": 0.99,
    "classifier": "MACHINE_LEARNING_v2"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Notification Alert Types
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Products and events for which users can receive notifications.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-alert-types
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-alert-types-get-alert-types
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Get Alert Types 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Gets a list of all alert types for which an account is eligible.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/alerting/v3/available_alerts
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/available_alerts" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "SSL": [
      {
        "display_name": "Universal SSL Alert",
        "type": "universal_ssl_event_type",
        "description": "Universal Certificate validation status, issuance, renewal, and expiration notices"
      }
    ]
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Notification Mechanism Eligibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Delivery mechanism availability
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-mechanism-eligibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-mechanism-eligibility-get-delivery-mechanism-eligibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Get delivery mechanism eligibility 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get a list of all delivery mechanism types for which an account is eligible.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/alerting/v3/destinations/eligible
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/eligible" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "email": {
      "eligible": true,
      "ready": true,
      "type": "email"
    }
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Notification destinations with PagerDuty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Users can configure a policy to dispatch via PagerDuty.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-destinations-with-pagerduty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-destinations-with-pagerduty-list-pagerduty-services
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List PagerDuty services 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get a list of all configured PagerDuty services
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/alerting/v3/destinations/pagerduty
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/pagerduty" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "My PagerDuty Service"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Notification policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Notification policies control which notifications you receive for your account.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-policies-list-notification-policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET List Notification policies 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get a list of all Notification policies.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/alerting/v3/policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/policies" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "SSL Notification Event Policy",
      "description": "Something describing the policy.",
      "enabled": true,
      "alert_type": "universal_ssl_event_type",
      "mechanisms": {
        "email": [
          {
            "id": "test@example.com"
          }
        ],
        "pagerduty": [
          {
            "id": "e8133a15-00a4-4d69-aec1-32f70c51f6e5"
          }
        ],
        "webhooks": [
          {
            "id": "14cc1190-5d2b-4b98-a696-c424cb2ad05f"
          }
        ]
      },
      "filters": {
        "slo": [
          "99.9"
        ]
      },
      "created": "2014-01-01T05:20:00.12345Z",
      "modified": "2014-01-01T05:20:00.12345Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-policies-get-notification-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET Get Notification policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Get details for a single policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          GET accounts/:identifier/alerting/v3/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "SSL Notification Event Policy",
    "description": "Something describing the policy.",
    "enabled": true,
    "alert_type": "universal_ssl_event_type",
    "mechanisms": {
      "email": [
        {
          "id": "test@example.com"
        }
      ],
      "pagerduty": [
        {
          "id": "e8133a15-00a4-4d69-aec1-32f70c51f6e5"
        }
      ],
      "webhooks": [
        {
          "id": "14cc1190-5d2b-4b98-a696-c424cb2ad05f"
        }
      ]
    },
    "filters": {
      "slo": [
        "99.9"
      ]
    },
    "created": "2014-01-01T05:20:00.12345Z",
    "modified": "2014-01-01T05:20:00.12345Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-policies-create-notification-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST Create Notification policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Creates a new Notification policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          POST accounts/:identifier/alerting/v3/policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "SSL Notification Event Policy"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enabled
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Whether or not the Notification policy is enabled.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • valid values: (true,false)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            alert_type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This is which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "universal_ssl_event_type"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mechanisms
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              List of ids that will be used when dispatching a notification. Ids for email type will be the email address.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
  "email": [
    {
      "id": "test@example.com"
    }
  ],
  "pagerduty": [
    {
      "id": "e8133a15-00a4-4d69-aec1-32f70c51f6e5"
    }
  ],
  "webhooks": [
    {
      "id": "14cc1190-5d2b-4b98-a696-c424cb2ad05f"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Optional description for the Notification policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "Something describing the policy."
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  {
  "slo": [
    "99.9"
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/policies" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"SSL Notification Event Policy","description":"Something describing the policy.","enabled":true,"alert_type":"universal_ssl_event_type","mechanisms":{"email":[{"id":"test@example.com"}],"pagerduty":[{"id":"e8133a15-00a4-4d69-aec1-32f70c51f6e5"}],"webhooks":[{"id":"14cc1190-5d2b-4b98-a696-c424cb2ad05f"}]},"filters":{"slo":["99.9"]}}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification-policies-update-notification-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT Update Notification policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update a Notification policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PUT accounts/:identifier/alerting/v3/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification-policies-delete-notification-policy
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE Delete Notification policy 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Delete a Notification policy.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DELETE accounts/:identifier/alerting/v3/policies/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/policies/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": []
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Notification webhooks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Notification webhooks are destination mechanisms that can be used in notification policies
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification-webhooks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Object definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View properties and constraints defined on the object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Show definition
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification-webhooks-list-webhooks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET List webhooks 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Gets a list of all configured webhook destinations.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/alerting/v3/destinations/webhooks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/webhooks" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "name": "Slack Webhook",
      "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd",
      "type": "slack",
      "created_at": "2020-10-26T18:25:04.532316Z",
      "last_success": "2020-10-26T18:25:04.532316Z",
      "last_failure": "2020-10-26T18:25:04.532316Z"
    }
  ]
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification-webhooks-get-webhook
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET Get webhook 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get details for a single webhooks destination.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    GET accounts/:identifier/alerting/v3/destinations/webhooks/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    curl -X GET "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/webhooks/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "Slack Webhook",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd",
    "type": "slack",
    "created_at": "2020-10-26T18:25:04.532316Z",
    "last_success": "2020-10-26T18:25:04.532316Z",
    "last_failure": "2020-10-26T18:25:04.532316Z"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    notification-webhooks-create-webhook
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST Create webhook 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Creates a new webhook destination.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    POST accounts/:identifier/alerting/v3/destinations/webhooks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The name of the webhook destination. This will be included in the request body when you receive a webhook notification.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "Slack Webhook"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The POST endpoint to call when dispatching a notification.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secret
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional secret that will be passed in the cf-webhook-auth header when dispatching a webhook notification. Secrets are not returned in any API response body.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          curl -X POST "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/webhooks" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Slack Webhook","url":"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          notification-webhooks-update-webhook
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT Update webhook 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Update a webhook destination.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PUT accounts/:identifier/alerting/v3/destinations/webhooks/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Required parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The name of the webhook destination. This will be included in the request body when you receive a webhook notification.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "Slack Webhook"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            url
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The POST endpoint to call when dispatching a notification.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Name /typeDescription /exampleConstraints
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secret
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Optional secret that will be passed in the cf-webhook-auth header when dispatching a webhook notification. Secrets are not returned in any API response body.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X PUT "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/webhooks/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json" \
     --data '{"name":"Slack Webhook","url":"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"}'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
  }
}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                notification-webhooks-delete-webhook
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE Delete webhook 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • free
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • pro
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • business
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • enterprise
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Delete a configured webhook destination.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DELETE accounts/:identifier/alerting/v3/destinations/webhooks/:uuid
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cURL (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/9a7806061c88ada191ed06f989cc3dac/alerting/v3/destinations/webhooks/f174e90a-fafe-4643-bbbc-4a0ed4fc8415" \
     -H "X-Auth-Email: user@example.com" \
     -H "X-Auth-Key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41" \
     -H "Content-Type: application/json"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Response (example)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                {
  "success": true,
  "errors": [],
  "messages": []
}